terraconstructs 0.0.17 → 0.0.18
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.
- package/.jsii +4533 -3
- package/lib/aws/arn.js +1 -1
- package/lib/aws/aws-construct.js +1 -1
- package/lib/aws/aws-stack.js +1 -1
- package/lib/aws/aws-tags.js +2 -2
- package/lib/aws/cloudwatch/actions/ec2.js +1 -1
- package/lib/aws/cloudwatch/actions/lambda.js +1 -1
- package/lib/aws/cloudwatch/alarm-base.js +1 -1
- package/lib/aws/cloudwatch/alarm-rule.js +1 -1
- package/lib/aws/cloudwatch/alarm-status-widget.js +1 -1
- package/lib/aws/cloudwatch/alarm.js +1 -1
- package/lib/aws/cloudwatch/composite-alarm.js +1 -1
- package/lib/aws/cloudwatch/dashboard.js +1 -1
- package/lib/aws/cloudwatch/data-protection-policy.js +3 -3
- package/lib/aws/cloudwatch/graph.js +8 -8
- package/lib/aws/cloudwatch/layout.js +3 -3
- package/lib/aws/cloudwatch/log-destinations/kinesis.js +1 -1
- package/lib/aws/cloudwatch/log-destinations/lambda.js +1 -1
- package/lib/aws/cloudwatch/log-group.js +1 -1
- package/lib/aws/cloudwatch/log-query.js +1 -1
- package/lib/aws/cloudwatch/log-stream.js +1 -1
- package/lib/aws/cloudwatch/metric-filter.js +1 -1
- package/lib/aws/cloudwatch/metric.js +2 -2
- package/lib/aws/cloudwatch/pattern.js +3 -3
- package/lib/aws/cloudwatch/policy.js +1 -1
- package/lib/aws/cloudwatch/query-definition.js +2 -2
- package/lib/aws/cloudwatch/stats.js +1 -1
- package/lib/aws/cloudwatch/subscription-filter.js +1 -1
- package/lib/aws/cloudwatch/text.js +1 -1
- package/lib/aws/cloudwatch/variable.js +3 -3
- package/lib/aws/cloudwatch/widget.js +1 -1
- package/lib/aws/compute/activity.js +1 -1
- package/lib/aws/compute/alb/application-listener-action.js +1 -1
- package/lib/aws/compute/alb/application-listener-certificate.js +1 -1
- package/lib/aws/compute/alb/application-listener-rule.js +1 -1
- package/lib/aws/compute/alb/application-listener.js +1 -1
- package/lib/aws/compute/alb/application-load-balancer.js +1 -1
- package/lib/aws/compute/alb/application-target-group.js +1 -1
- package/lib/aws/compute/alb/conditions.js +1 -1
- package/lib/aws/compute/alb/trust-store-revocation.js +1 -1
- package/lib/aws/compute/alb/trust-store.js +1 -1
- package/lib/aws/compute/architecture.js +1 -1
- package/lib/aws/compute/aspects/require-imdsv2-aspect.js +2 -2
- package/lib/aws/compute/bastion-host.js +1 -1
- package/lib/aws/compute/chain.js +1 -1
- package/lib/aws/compute/client-vpn-authorization-rule.js +1 -1
- package/lib/aws/compute/client-vpn-endpoint.js +2 -2
- package/lib/aws/compute/client-vpn-route.js +2 -2
- package/lib/aws/compute/condition.js +1 -1
- package/lib/aws/compute/connections.js +1 -1
- package/lib/aws/compute/event-invoke-config.js +1 -1
- package/lib/aws/compute/event-source-filter.js +2 -2
- package/lib/aws/compute/event-source-mapping.js +1 -1
- package/lib/aws/compute/event-sources/s3-onfailure-destination.js +1 -1
- package/lib/aws/compute/event-sources/s3.js +1 -1
- package/lib/aws/compute/event-sources/sqs-dlq.js +1 -1
- package/lib/aws/compute/event-sources/sqs.js +1 -1
- package/lib/aws/compute/fields.js +4 -4
- package/lib/aws/compute/function-alias.js +1 -1
- package/lib/aws/compute/function-base.js +2 -2
- package/lib/aws/compute/function-destinations/event-bridge.js +1 -1
- package/lib/aws/compute/function-destinations/function.js +1 -1
- package/lib/aws/compute/function-destinations/sqs.js +1 -1
- package/lib/aws/compute/function-nodejs.js +1 -1
- package/lib/aws/compute/function-url.js +1 -1
- package/lib/aws/compute/function.js +1 -1
- package/lib/aws/compute/instance-types.js +1 -1
- package/lib/aws/compute/instance.js +1 -1
- package/lib/aws/compute/ip-addresses.js +2 -2
- package/lib/aws/compute/ipam.js +1 -1
- package/lib/aws/compute/key-pair.js +1 -1
- package/lib/aws/compute/launch-template.js +2 -2
- package/lib/aws/compute/lb-shared/base-listener.js +1 -1
- package/lib/aws/compute/lb-shared/base-load-balancer.js +2 -2
- package/lib/aws/compute/lb-shared/base-target-group.js +1 -1
- package/lib/aws/compute/lb-shared/listener-certificate.js +1 -1
- package/lib/aws/compute/lb-shared/load-balancer-targets.js +2 -2
- package/lib/aws/compute/lb-targets/alb-target.js +3 -3
- package/lib/aws/compute/lb-targets/instance-target.js +2 -2
- package/lib/aws/compute/lb-targets/ip-target.js +1 -1
- package/lib/aws/compute/lb-targets/lambda-target.js +1 -1
- package/lib/aws/compute/load-balancer.js +3 -3
- package/lib/aws/compute/machine-image/amazon-linux-2022.js +2 -2
- package/lib/aws/compute/machine-image/amazon-linux-2023.js +2 -2
- package/lib/aws/compute/machine-image/amazon-linux2.js +2 -2
- package/lib/aws/compute/machine-image/common.js +1 -1
- package/lib/aws/compute/machine-image/machine-image.js +8 -8
- package/lib/aws/compute/nat.js +5 -5
- package/lib/aws/compute/network-acl-types.js +2 -2
- package/lib/aws/compute/network-acl.js +3 -3
- package/lib/aws/compute/nlb/network-listener-action.js +1 -1
- package/lib/aws/compute/nlb/network-listener.js +1 -1
- package/lib/aws/compute/nlb/network-load-balancer.js +1 -1
- package/lib/aws/compute/nlb/network-target-group.js +1 -1
- package/lib/aws/compute/peer.js +1 -1
- package/lib/aws/compute/placement-group.js +1 -1
- package/lib/aws/compute/port.js +1 -1
- package/lib/aws/compute/prefix-list.js +1 -1
- package/lib/aws/compute/route.js +8 -8
- package/lib/aws/compute/security-group.js +1 -1
- package/lib/aws/compute/state-graph.js +1 -1
- package/lib/aws/compute/state-machine-fragment.js +1 -1
- package/lib/aws/compute/state-machine.js +4 -4
- package/lib/aws/compute/states/choice.js +1 -1
- package/lib/aws/compute/states/custom-state.js +1 -1
- package/lib/aws/compute/states/distributed-map/item-batcher.js +1 -1
- package/lib/aws/compute/states/distributed-map/item-reader.js +5 -5
- package/lib/aws/compute/states/distributed-map/result-writer.js +1 -1
- package/lib/aws/compute/states/distributed-map.js +1 -1
- package/lib/aws/compute/states/fail.js +1 -1
- package/lib/aws/compute/states/map-base.js +1 -1
- package/lib/aws/compute/states/map.js +1 -1
- package/lib/aws/compute/states/parallel.js +1 -1
- package/lib/aws/compute/states/pass.js +2 -2
- package/lib/aws/compute/states/state.js +1 -1
- package/lib/aws/compute/states/succeed.js +1 -1
- package/lib/aws/compute/states/task-base.js +2 -2
- package/lib/aws/compute/states/task.js +1 -1
- package/lib/aws/compute/states/wait.js +2 -2
- package/lib/aws/compute/subnet-v2.js +2 -2
- package/lib/aws/compute/subnet.js +1 -1
- package/lib/aws/compute/task-credentials.js +1 -1
- package/lib/aws/compute/task-input.js +1 -1
- package/lib/aws/compute/tasks/aws-sdk/call-aws-service.js +1 -1
- package/lib/aws/compute/tasks/eventbridge/put-events.js +1 -1
- package/lib/aws/compute/tasks/http/invoke.js +1 -1
- package/lib/aws/compute/tasks/lambda/invoke.js +1 -1
- package/lib/aws/compute/tasks/sqs/send-message.js +1 -1
- package/lib/aws/compute/tasks/stepfunctions/invoke-activity.js +1 -1
- package/lib/aws/compute/tasks/stepfunctions/start-execution.js +1 -1
- package/lib/aws/compute/types.js +1 -1
- package/lib/aws/compute/user-data.js +3 -3
- package/lib/aws/compute/volume.js +2 -2
- package/lib/aws/compute/vpc-endpoint-service.js +1 -1
- package/lib/aws/compute/vpc-endpoint.js +6 -6
- package/lib/aws/compute/vpc-flow-logs.js +4 -4
- package/lib/aws/compute/vpc-v2-base.js +1 -1
- package/lib/aws/compute/vpc-v2.js +2 -2
- package/lib/aws/compute/vpc.js +4 -4
- package/lib/aws/compute/vpn.js +3 -3
- package/lib/aws/edge/certificate.js +1 -1
- package/lib/aws/edge/distribution.js +3 -3
- package/lib/aws/edge/dns-alias-record-targets.js +3 -3
- package/lib/aws/edge/dns-record.js +13 -13
- package/lib/aws/edge/dns-zone.js +1 -1
- package/lib/aws/edge/function.js +2 -2
- package/lib/aws/edge/key-value-store.js +4 -4
- package/lib/aws/edge/origin.js +3 -3
- package/lib/aws/edge/response-headers-policy.js +1 -1
- package/lib/aws/encryption/alias.js +1 -1
- package/lib/aws/encryption/key.js +1 -1
- package/lib/aws/encryption/via-service-principal.js +1 -1
- package/lib/aws/iam/grant.js +2 -2
- package/lib/aws/iam/group.js +1 -1
- package/lib/aws/iam/instance-profile.js +1 -1
- package/lib/aws/iam/managed-policy.js +1 -1
- package/lib/aws/iam/oidc-provider.js +1 -1
- package/lib/aws/iam/policy-document.js +1 -1
- package/lib/aws/iam/policy-statement.js +1 -1
- package/lib/aws/iam/policy.js +1 -1
- package/lib/aws/iam/principals.js +20 -20
- package/lib/aws/iam/role.js +1 -1
- package/lib/aws/iam/saml-provider.js +2 -2
- package/lib/aws/iam/unknown-principal.js +1 -1
- package/lib/aws/iam/user.js +1 -1
- package/lib/aws/network/simple-ipv4-vpc.js +1 -1
- package/lib/aws/network/subnet-group.js +3 -3
- package/lib/aws/network/subnet.js +4 -4
- package/lib/aws/notify/archive.js +1 -1
- package/lib/aws/notify/connection.js +3 -3
- package/lib/aws/notify/delivery-policy.d.ts +114 -0
- package/lib/aws/notify/delivery-policy.js +27 -0
- package/lib/aws/notify/event-bus.js +3 -3
- package/lib/aws/notify/event-pattern.js +1 -1
- package/lib/aws/notify/index.d.ts +11 -0
- package/lib/aws/notify/index.js +14 -1
- package/lib/aws/notify/input.js +2 -2
- package/lib/aws/notify/kinesis-stream.js +1 -1
- package/lib/aws/notify/notification-rule-source.d.ts +20 -0
- package/lib/aws/notify/notification-rule-source.js +4 -0
- package/lib/aws/notify/notification-rule-target.d.ts +24 -0
- package/lib/aws/notify/notification-rule-target.js +4 -0
- package/lib/aws/notify/notification-rule.d.ts +123 -0
- package/lib/aws/notify/notification-rule.js +129 -0
- package/lib/aws/notify/policy.d.ts +56 -0
- package/lib/aws/notify/policy.js +83 -0
- package/lib/aws/notify/queue-policy.js +1 -1
- package/lib/aws/notify/queue.js +1 -1
- package/lib/aws/notify/resource-policy.js +1 -1
- package/lib/aws/notify/rule.js +1 -1
- package/lib/aws/notify/schedule.js +1 -1
- package/lib/aws/notify/sns-augmentations.generated.d.ts +125 -0
- package/lib/aws/notify/sns-augmentations.generated.js +71 -0
- package/lib/aws/notify/sns-canned-metrics.generated.d.ts +33 -0
- package/lib/aws/notify/sns-canned-metrics.generated.js +47 -0
- package/lib/aws/notify/subscriber.d.ts +44 -0
- package/lib/aws/notify/subscriber.js +4 -0
- package/lib/aws/notify/subscription-filter.d.ts +129 -0
- package/lib/aws/notify/subscription-filter.js +105 -0
- package/lib/aws/notify/subscription.d.ts +219 -0
- package/lib/aws/notify/subscription.js +357 -0
- package/lib/aws/notify/targets/event-bus.js +1 -1
- package/lib/aws/notify/targets/function.js +1 -1
- package/lib/aws/notify/targets/log-group.js +2 -2
- package/lib/aws/notify/targets/sqs.js +1 -1
- package/lib/aws/notify/targets/state-machine.js +1 -1
- package/lib/aws/notify/topic-base.d.ts +155 -0
- package/lib/aws/notify/topic-base.js +175 -0
- package/lib/aws/notify/topic.d.ts +222 -0
- package/lib/aws/notify/topic.js +219 -0
- package/lib/aws/storage/bucket-notifications.js +1 -1
- package/lib/aws/storage/bucket-policy.js +1 -1
- package/lib/aws/storage/bucket-source.js +1 -1
- package/lib/aws/storage/bucket.js +2 -2
- package/lib/aws/storage/notification-targets/function.js +1 -1
- package/lib/aws/storage/notification-targets/queue.js +1 -1
- package/lib/aws/storage/origin-access-identity.js +1 -1
- package/lib/aws/storage/parameter.js +2 -2
- package/lib/construct-base.js +2 -2
- package/lib/duration.js +1 -1
- package/lib/expiration.js +1 -1
- package/lib/size.js +1 -1
- package/lib/stack-base.js +1 -1
- package/lib/terra-func.js +1 -1
- package/package.json +1 -1
package/.jsii
CHANGED
|
@@ -2425,7 +2425,7 @@
|
|
|
2425
2425
|
"terraconstructs.aws.notify.targets": {
|
|
2426
2426
|
"locationInModule": {
|
|
2427
2427
|
"filename": "src/aws/notify/index.ts",
|
|
2428
|
-
"line":
|
|
2428
|
+
"line": 30
|
|
2429
2429
|
},
|
|
2430
2430
|
"symbolId": "src/aws/notify/targets/index:"
|
|
2431
2431
|
},
|
|
@@ -134894,6 +134894,52 @@
|
|
|
134894
134894
|
"namespace": "aws.notify",
|
|
134895
134895
|
"symbolId": "src/aws/notify/connection:Authorization"
|
|
134896
134896
|
},
|
|
134897
|
+
"terraconstructs.aws.notify.BackoffFunction": {
|
|
134898
|
+
"assembly": "terraconstructs",
|
|
134899
|
+
"docs": {
|
|
134900
|
+
"stability": "stable",
|
|
134901
|
+
"summary": "Algorithms which can be used by SNS to calculate the delays associated with all of the retry attempts between the first and last retries in the backoff phase."
|
|
134902
|
+
},
|
|
134903
|
+
"fqn": "terraconstructs.aws.notify.BackoffFunction",
|
|
134904
|
+
"kind": "enum",
|
|
134905
|
+
"locationInModule": {
|
|
134906
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
134907
|
+
"line": 8
|
|
134908
|
+
},
|
|
134909
|
+
"members": [
|
|
134910
|
+
{
|
|
134911
|
+
"docs": {
|
|
134912
|
+
"stability": "stable",
|
|
134913
|
+
"summary": "Arithmetic, see {@link https://docs.aws.amazon.com/images/sns/latest/dg/images/backoff-graph.png this image} for how this function compares to others."
|
|
134914
|
+
},
|
|
134915
|
+
"name": "ARITHMETIC"
|
|
134916
|
+
},
|
|
134917
|
+
{
|
|
134918
|
+
"docs": {
|
|
134919
|
+
"stability": "stable",
|
|
134920
|
+
"summary": "Exponential, see {@link https://docs.aws.amazon.com/images/sns/latest/dg/images/backoff-graph.png this image} for how this function compares to others."
|
|
134921
|
+
},
|
|
134922
|
+
"name": "EXPONENTIAL"
|
|
134923
|
+
},
|
|
134924
|
+
{
|
|
134925
|
+
"docs": {
|
|
134926
|
+
"stability": "stable",
|
|
134927
|
+
"summary": "Geometric, see {@link https://docs.aws.amazon.com/images/sns/latest/dg/images/backoff-graph.png this image} for how this function compares to others."
|
|
134928
|
+
},
|
|
134929
|
+
"name": "GEOMETRIC"
|
|
134930
|
+
},
|
|
134931
|
+
{
|
|
134932
|
+
"docs": {
|
|
134933
|
+
"stability": "stable",
|
|
134934
|
+
"summary": "Linear, see {@link https://docs.aws.amazon.com/images/sns/latest/dg/images/backoff-graph.png this image} for how this function compares to others."
|
|
134935
|
+
},
|
|
134936
|
+
"name": "LINEAR"
|
|
134937
|
+
}
|
|
134938
|
+
],
|
|
134939
|
+
"name": "BackoffFunction",
|
|
134940
|
+
"namespace": "aws.notify",
|
|
134941
|
+
"symbolId": "src/aws/notify/delivery-policy:BackoffFunction"
|
|
134942
|
+
},
|
|
134897
134943
|
"terraconstructs.aws.notify.BaseArchiveProps": {
|
|
134898
134944
|
"assembly": "terraconstructs",
|
|
134899
134945
|
"datatype": true,
|
|
@@ -134988,6 +135034,57 @@
|
|
|
134988
135034
|
],
|
|
134989
135035
|
"symbolId": "src/aws/notify/archive:BaseArchiveProps"
|
|
134990
135036
|
},
|
|
135037
|
+
"terraconstructs.aws.notify.BetweenCondition": {
|
|
135038
|
+
"assembly": "terraconstructs",
|
|
135039
|
+
"datatype": true,
|
|
135040
|
+
"docs": {
|
|
135041
|
+
"stability": "stable",
|
|
135042
|
+
"summary": "Between condition for a numeric attribute."
|
|
135043
|
+
},
|
|
135044
|
+
"fqn": "terraconstructs.aws.notify.BetweenCondition",
|
|
135045
|
+
"kind": "interface",
|
|
135046
|
+
"locationInModule": {
|
|
135047
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
135048
|
+
"line": 57
|
|
135049
|
+
},
|
|
135050
|
+
"name": "BetweenCondition",
|
|
135051
|
+
"namespace": "aws.notify",
|
|
135052
|
+
"properties": [
|
|
135053
|
+
{
|
|
135054
|
+
"abstract": true,
|
|
135055
|
+
"docs": {
|
|
135056
|
+
"stability": "stable",
|
|
135057
|
+
"summary": "The start value."
|
|
135058
|
+
},
|
|
135059
|
+
"immutable": true,
|
|
135060
|
+
"locationInModule": {
|
|
135061
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
135062
|
+
"line": 61
|
|
135063
|
+
},
|
|
135064
|
+
"name": "start",
|
|
135065
|
+
"type": {
|
|
135066
|
+
"primitive": "number"
|
|
135067
|
+
}
|
|
135068
|
+
},
|
|
135069
|
+
{
|
|
135070
|
+
"abstract": true,
|
|
135071
|
+
"docs": {
|
|
135072
|
+
"stability": "stable",
|
|
135073
|
+
"summary": "The stop value."
|
|
135074
|
+
},
|
|
135075
|
+
"immutable": true,
|
|
135076
|
+
"locationInModule": {
|
|
135077
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
135078
|
+
"line": 66
|
|
135079
|
+
},
|
|
135080
|
+
"name": "stop",
|
|
135081
|
+
"type": {
|
|
135082
|
+
"primitive": "number"
|
|
135083
|
+
}
|
|
135084
|
+
}
|
|
135085
|
+
],
|
|
135086
|
+
"symbolId": "src/aws/notify/subscription-filter:BetweenCondition"
|
|
135087
|
+
},
|
|
134991
135088
|
"terraconstructs.aws.notify.Connection": {
|
|
134992
135089
|
"assembly": "terraconstructs",
|
|
134993
135090
|
"base": "terraconstructs.aws.AwsConstructBase",
|
|
@@ -135741,6 +135838,111 @@
|
|
|
135741
135838
|
"namespace": "aws.notify",
|
|
135742
135839
|
"symbolId": "src/aws/notify/queue:DeduplicationScope"
|
|
135743
135840
|
},
|
|
135841
|
+
"terraconstructs.aws.notify.DeliveryPolicy": {
|
|
135842
|
+
"assembly": "terraconstructs",
|
|
135843
|
+
"datatype": true,
|
|
135844
|
+
"docs": {
|
|
135845
|
+
"stability": "stable",
|
|
135846
|
+
"summary": "Options for customising the delivery of SNS messages to HTTP/S endpoints."
|
|
135847
|
+
},
|
|
135848
|
+
"fqn": "terraconstructs.aws.notify.DeliveryPolicy",
|
|
135849
|
+
"kind": "interface",
|
|
135850
|
+
"locationInModule": {
|
|
135851
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
135852
|
+
"line": 107
|
|
135853
|
+
},
|
|
135854
|
+
"name": "DeliveryPolicy",
|
|
135855
|
+
"namespace": "aws.notify",
|
|
135856
|
+
"properties": [
|
|
135857
|
+
{
|
|
135858
|
+
"abstract": true,
|
|
135859
|
+
"docs": {
|
|
135860
|
+
"default": "- Amazon SNS attempts up to three retries with a delay between failed attempts set at 20 seconds",
|
|
135861
|
+
"stability": "stable",
|
|
135862
|
+
"summary": "The retry policy of the delivery of SNS messages to HTTP/S endpoints."
|
|
135863
|
+
},
|
|
135864
|
+
"immutable": true,
|
|
135865
|
+
"locationInModule": {
|
|
135866
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
135867
|
+
"line": 113
|
|
135868
|
+
},
|
|
135869
|
+
"name": "healthyRetryPolicy",
|
|
135870
|
+
"optional": true,
|
|
135871
|
+
"type": {
|
|
135872
|
+
"fqn": "terraconstructs.aws.notify.HealthyRetryPolicy"
|
|
135873
|
+
}
|
|
135874
|
+
},
|
|
135875
|
+
{
|
|
135876
|
+
"abstract": true,
|
|
135877
|
+
"docs": {
|
|
135878
|
+
"default": "- The content type is set to 'text/plain; charset=UTF-8'",
|
|
135879
|
+
"stability": "stable",
|
|
135880
|
+
"summary": "The request of the content sent in AWS SNS HTTP/S requests."
|
|
135881
|
+
},
|
|
135882
|
+
"immutable": true,
|
|
135883
|
+
"locationInModule": {
|
|
135884
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
135885
|
+
"line": 127
|
|
135886
|
+
},
|
|
135887
|
+
"name": "requestPolicy",
|
|
135888
|
+
"optional": true,
|
|
135889
|
+
"type": {
|
|
135890
|
+
"fqn": "terraconstructs.aws.notify.RequestPolicy"
|
|
135891
|
+
}
|
|
135892
|
+
},
|
|
135893
|
+
{
|
|
135894
|
+
"abstract": true,
|
|
135895
|
+
"docs": {
|
|
135896
|
+
"default": "- No throttling",
|
|
135897
|
+
"stability": "stable",
|
|
135898
|
+
"summary": "The throttling policy of the delivery of SNS messages to HTTP/S endpoints."
|
|
135899
|
+
},
|
|
135900
|
+
"immutable": true,
|
|
135901
|
+
"locationInModule": {
|
|
135902
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
135903
|
+
"line": 120
|
|
135904
|
+
},
|
|
135905
|
+
"name": "throttlePolicy",
|
|
135906
|
+
"optional": true,
|
|
135907
|
+
"type": {
|
|
135908
|
+
"fqn": "terraconstructs.aws.notify.ThrottlePolicy"
|
|
135909
|
+
}
|
|
135910
|
+
}
|
|
135911
|
+
],
|
|
135912
|
+
"symbolId": "src/aws/notify/delivery-policy:DeliveryPolicy"
|
|
135913
|
+
},
|
|
135914
|
+
"terraconstructs.aws.notify.DetailType": {
|
|
135915
|
+
"assembly": "terraconstructs",
|
|
135916
|
+
"docs": {
|
|
135917
|
+
"stability": "stable",
|
|
135918
|
+
"summary": "The level of detail to include in the notifications for this resource."
|
|
135919
|
+
},
|
|
135920
|
+
"fqn": "terraconstructs.aws.notify.DetailType",
|
|
135921
|
+
"kind": "enum",
|
|
135922
|
+
"locationInModule": {
|
|
135923
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
135924
|
+
"line": 16
|
|
135925
|
+
},
|
|
135926
|
+
"members": [
|
|
135927
|
+
{
|
|
135928
|
+
"docs": {
|
|
135929
|
+
"stability": "stable",
|
|
135930
|
+
"summary": "BASIC will include only the contents of the event as it would appear in AWS CloudWatch."
|
|
135931
|
+
},
|
|
135932
|
+
"name": "BASIC"
|
|
135933
|
+
},
|
|
135934
|
+
{
|
|
135935
|
+
"docs": {
|
|
135936
|
+
"stability": "stable",
|
|
135937
|
+
"summary": "FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created."
|
|
135938
|
+
},
|
|
135939
|
+
"name": "FULL"
|
|
135940
|
+
}
|
|
135941
|
+
],
|
|
135942
|
+
"name": "DetailType",
|
|
135943
|
+
"namespace": "aws.notify",
|
|
135944
|
+
"symbolId": "src/aws/notify/notification-rule:DetailType"
|
|
135945
|
+
},
|
|
135744
135946
|
"terraconstructs.aws.notify.EventBridgePermission": {
|
|
135745
135947
|
"assembly": "terraconstructs",
|
|
135746
135948
|
"base": "terraconstructs.aws.AwsConstructBase",
|
|
@@ -137362,6 +137564,389 @@
|
|
|
137362
137564
|
"namespace": "aws.notify",
|
|
137363
137565
|
"symbolId": "src/aws/notify/queue:FifoThroughputLimit"
|
|
137364
137566
|
},
|
|
137567
|
+
"terraconstructs.aws.notify.Filter": {
|
|
137568
|
+
"assembly": "terraconstructs",
|
|
137569
|
+
"base": "terraconstructs.aws.notify.FilterOrPolicy",
|
|
137570
|
+
"docs": {
|
|
137571
|
+
"stability": "stable",
|
|
137572
|
+
"summary": "Filter implementation of FilterOrPolicy."
|
|
137573
|
+
},
|
|
137574
|
+
"fqn": "terraconstructs.aws.notify.Filter",
|
|
137575
|
+
"initializer": {
|
|
137576
|
+
"docs": {
|
|
137577
|
+
"stability": "stable",
|
|
137578
|
+
"summary": "Policy constructor."
|
|
137579
|
+
},
|
|
137580
|
+
"locationInModule": {
|
|
137581
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
137582
|
+
"line": 560
|
|
137583
|
+
},
|
|
137584
|
+
"parameters": [
|
|
137585
|
+
{
|
|
137586
|
+
"docs": {
|
|
137587
|
+
"summary": "filter argument to construct."
|
|
137588
|
+
},
|
|
137589
|
+
"name": "filterDoc",
|
|
137590
|
+
"type": {
|
|
137591
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionFilter"
|
|
137592
|
+
}
|
|
137593
|
+
}
|
|
137594
|
+
]
|
|
137595
|
+
},
|
|
137596
|
+
"kind": "class",
|
|
137597
|
+
"locationInModule": {
|
|
137598
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
137599
|
+
"line": 551
|
|
137600
|
+
},
|
|
137601
|
+
"name": "Filter",
|
|
137602
|
+
"namespace": "aws.notify",
|
|
137603
|
+
"properties": [
|
|
137604
|
+
{
|
|
137605
|
+
"docs": {
|
|
137606
|
+
"stability": "stable",
|
|
137607
|
+
"summary": "filter argument to construct."
|
|
137608
|
+
},
|
|
137609
|
+
"immutable": true,
|
|
137610
|
+
"locationInModule": {
|
|
137611
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
137612
|
+
"line": 560
|
|
137613
|
+
},
|
|
137614
|
+
"name": "filterDoc",
|
|
137615
|
+
"type": {
|
|
137616
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionFilter"
|
|
137617
|
+
}
|
|
137618
|
+
},
|
|
137619
|
+
{
|
|
137620
|
+
"docs": {
|
|
137621
|
+
"stability": "stable",
|
|
137622
|
+
"summary": "Type used in DFS buildFilterPolicyWithMessageBody to determine json value type."
|
|
137623
|
+
},
|
|
137624
|
+
"immutable": true,
|
|
137625
|
+
"locationInModule": {
|
|
137626
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
137627
|
+
"line": 555
|
|
137628
|
+
},
|
|
137629
|
+
"name": "type",
|
|
137630
|
+
"overrides": "terraconstructs.aws.notify.FilterOrPolicy",
|
|
137631
|
+
"type": {
|
|
137632
|
+
"fqn": "terraconstructs.aws.notify.FilterOrPolicyType"
|
|
137633
|
+
}
|
|
137634
|
+
}
|
|
137635
|
+
],
|
|
137636
|
+
"symbolId": "src/aws/notify/subscription:Filter"
|
|
137637
|
+
},
|
|
137638
|
+
"terraconstructs.aws.notify.FilterOrPolicy": {
|
|
137639
|
+
"abstract": true,
|
|
137640
|
+
"assembly": "terraconstructs",
|
|
137641
|
+
"docs": {
|
|
137642
|
+
"stability": "stable",
|
|
137643
|
+
"summary": "Class for building the FilterPolicy by avoiding union types."
|
|
137644
|
+
},
|
|
137645
|
+
"fqn": "terraconstructs.aws.notify.FilterOrPolicy",
|
|
137646
|
+
"initializer": {
|
|
137647
|
+
"docs": {
|
|
137648
|
+
"stability": "stable"
|
|
137649
|
+
}
|
|
137650
|
+
},
|
|
137651
|
+
"kind": "class",
|
|
137652
|
+
"locationInModule": {
|
|
137653
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
137654
|
+
"line": 513
|
|
137655
|
+
},
|
|
137656
|
+
"methods": [
|
|
137657
|
+
{
|
|
137658
|
+
"docs": {
|
|
137659
|
+
"stability": "stable",
|
|
137660
|
+
"summary": "Filter of MessageBody."
|
|
137661
|
+
},
|
|
137662
|
+
"locationInModule": {
|
|
137663
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
137664
|
+
"line": 517
|
|
137665
|
+
},
|
|
137666
|
+
"name": "filter",
|
|
137667
|
+
"parameters": [
|
|
137668
|
+
{
|
|
137669
|
+
"name": "filter",
|
|
137670
|
+
"type": {
|
|
137671
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionFilter"
|
|
137672
|
+
}
|
|
137673
|
+
}
|
|
137674
|
+
],
|
|
137675
|
+
"returns": {
|
|
137676
|
+
"type": {
|
|
137677
|
+
"fqn": "terraconstructs.aws.notify.Filter"
|
|
137678
|
+
}
|
|
137679
|
+
},
|
|
137680
|
+
"static": true
|
|
137681
|
+
},
|
|
137682
|
+
{
|
|
137683
|
+
"docs": {
|
|
137684
|
+
"stability": "stable",
|
|
137685
|
+
"summary": "Policy of MessageBody."
|
|
137686
|
+
},
|
|
137687
|
+
"locationInModule": {
|
|
137688
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
137689
|
+
"line": 524
|
|
137690
|
+
},
|
|
137691
|
+
"name": "policy",
|
|
137692
|
+
"parameters": [
|
|
137693
|
+
{
|
|
137694
|
+
"name": "policy",
|
|
137695
|
+
"type": {
|
|
137696
|
+
"collection": {
|
|
137697
|
+
"elementtype": {
|
|
137698
|
+
"fqn": "terraconstructs.aws.notify.FilterOrPolicy"
|
|
137699
|
+
},
|
|
137700
|
+
"kind": "map"
|
|
137701
|
+
}
|
|
137702
|
+
}
|
|
137703
|
+
}
|
|
137704
|
+
],
|
|
137705
|
+
"returns": {
|
|
137706
|
+
"type": {
|
|
137707
|
+
"fqn": "terraconstructs.aws.notify.Policy"
|
|
137708
|
+
}
|
|
137709
|
+
},
|
|
137710
|
+
"static": true
|
|
137711
|
+
},
|
|
137712
|
+
{
|
|
137713
|
+
"docs": {
|
|
137714
|
+
"stability": "stable",
|
|
137715
|
+
"summary": "Check if instance is `Filter` type."
|
|
137716
|
+
},
|
|
137717
|
+
"locationInModule": {
|
|
137718
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
137719
|
+
"line": 543
|
|
137720
|
+
},
|
|
137721
|
+
"name": "isFilter",
|
|
137722
|
+
"returns": {
|
|
137723
|
+
"type": {
|
|
137724
|
+
"primitive": "boolean"
|
|
137725
|
+
}
|
|
137726
|
+
}
|
|
137727
|
+
},
|
|
137728
|
+
{
|
|
137729
|
+
"docs": {
|
|
137730
|
+
"stability": "stable",
|
|
137731
|
+
"summary": "Check if instance is `Policy` type."
|
|
137732
|
+
},
|
|
137733
|
+
"locationInModule": {
|
|
137734
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
137735
|
+
"line": 536
|
|
137736
|
+
},
|
|
137737
|
+
"name": "isPolicy",
|
|
137738
|
+
"returns": {
|
|
137739
|
+
"type": {
|
|
137740
|
+
"primitive": "boolean"
|
|
137741
|
+
}
|
|
137742
|
+
}
|
|
137743
|
+
}
|
|
137744
|
+
],
|
|
137745
|
+
"name": "FilterOrPolicy",
|
|
137746
|
+
"namespace": "aws.notify",
|
|
137747
|
+
"properties": [
|
|
137748
|
+
{
|
|
137749
|
+
"abstract": true,
|
|
137750
|
+
"docs": {
|
|
137751
|
+
"stability": "stable",
|
|
137752
|
+
"summary": "Type switch for disambiguating between subclasses."
|
|
137753
|
+
},
|
|
137754
|
+
"immutable": true,
|
|
137755
|
+
"locationInModule": {
|
|
137756
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
137757
|
+
"line": 531
|
|
137758
|
+
},
|
|
137759
|
+
"name": "type",
|
|
137760
|
+
"type": {
|
|
137761
|
+
"fqn": "terraconstructs.aws.notify.FilterOrPolicyType"
|
|
137762
|
+
}
|
|
137763
|
+
}
|
|
137764
|
+
],
|
|
137765
|
+
"symbolId": "src/aws/notify/subscription:FilterOrPolicy"
|
|
137766
|
+
},
|
|
137767
|
+
"terraconstructs.aws.notify.FilterOrPolicyType": {
|
|
137768
|
+
"assembly": "terraconstructs",
|
|
137769
|
+
"docs": {
|
|
137770
|
+
"stability": "stable",
|
|
137771
|
+
"summary": "The type of the MessageBody at a given key value pair."
|
|
137772
|
+
},
|
|
137773
|
+
"fqn": "terraconstructs.aws.notify.FilterOrPolicyType",
|
|
137774
|
+
"kind": "enum",
|
|
137775
|
+
"locationInModule": {
|
|
137776
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
137777
|
+
"line": 499
|
|
137778
|
+
},
|
|
137779
|
+
"members": [
|
|
137780
|
+
{
|
|
137781
|
+
"docs": {
|
|
137782
|
+
"stability": "stable",
|
|
137783
|
+
"summary": "The filter of the MessageBody."
|
|
137784
|
+
},
|
|
137785
|
+
"name": "FILTER"
|
|
137786
|
+
},
|
|
137787
|
+
{
|
|
137788
|
+
"docs": {
|
|
137789
|
+
"stability": "stable",
|
|
137790
|
+
"summary": "A nested key of the MessageBody."
|
|
137791
|
+
},
|
|
137792
|
+
"name": "POLICY"
|
|
137793
|
+
}
|
|
137794
|
+
],
|
|
137795
|
+
"name": "FilterOrPolicyType",
|
|
137796
|
+
"namespace": "aws.notify",
|
|
137797
|
+
"symbolId": "src/aws/notify/subscription:FilterOrPolicyType"
|
|
137798
|
+
},
|
|
137799
|
+
"terraconstructs.aws.notify.HealthyRetryPolicy": {
|
|
137800
|
+
"assembly": "terraconstructs",
|
|
137801
|
+
"datatype": true,
|
|
137802
|
+
"docs": {
|
|
137803
|
+
"stability": "stable",
|
|
137804
|
+
"summary": "Options for customising the retry policy of the delivery of SNS messages to HTTP/S endpoints."
|
|
137805
|
+
},
|
|
137806
|
+
"fqn": "terraconstructs.aws.notify.HealthyRetryPolicy",
|
|
137807
|
+
"kind": "interface",
|
|
137808
|
+
"locationInModule": {
|
|
137809
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
137810
|
+
"line": 54
|
|
137811
|
+
},
|
|
137812
|
+
"name": "HealthyRetryPolicy",
|
|
137813
|
+
"namespace": "aws.notify",
|
|
137814
|
+
"properties": [
|
|
137815
|
+
{
|
|
137816
|
+
"abstract": true,
|
|
137817
|
+
"docs": {
|
|
137818
|
+
"default": "- linear",
|
|
137819
|
+
"stability": "stable",
|
|
137820
|
+
"summary": "The model for backoff between retries."
|
|
137821
|
+
},
|
|
137822
|
+
"immutable": true,
|
|
137823
|
+
"locationInModule": {
|
|
137824
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
137825
|
+
"line": 101
|
|
137826
|
+
},
|
|
137827
|
+
"name": "backoffFunction",
|
|
137828
|
+
"optional": true,
|
|
137829
|
+
"type": {
|
|
137830
|
+
"fqn": "terraconstructs.aws.notify.BackoffFunction"
|
|
137831
|
+
}
|
|
137832
|
+
},
|
|
137833
|
+
{
|
|
137834
|
+
"abstract": true,
|
|
137835
|
+
"docs": {
|
|
137836
|
+
"default": "- 20 seconds",
|
|
137837
|
+
"remarks": "Must be at least `minDelayTarget` less than 3,600 seconds, and correspond to a whole number of seconds,",
|
|
137838
|
+
"stability": "stable",
|
|
137839
|
+
"summary": "The maximum delay for a retry."
|
|
137840
|
+
},
|
|
137841
|
+
"immutable": true,
|
|
137842
|
+
"locationInModule": {
|
|
137843
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
137844
|
+
"line": 66
|
|
137845
|
+
},
|
|
137846
|
+
"name": "maxDelayTarget",
|
|
137847
|
+
"optional": true,
|
|
137848
|
+
"type": {
|
|
137849
|
+
"fqn": "terraconstructs.Duration"
|
|
137850
|
+
}
|
|
137851
|
+
},
|
|
137852
|
+
{
|
|
137853
|
+
"abstract": true,
|
|
137854
|
+
"docs": {
|
|
137855
|
+
"default": "- 20 seconds",
|
|
137856
|
+
"remarks": "Must be at least one second, not exceed `maxDelayTarget`, and correspond to a whole number of seconds.",
|
|
137857
|
+
"stability": "stable",
|
|
137858
|
+
"summary": "The minimum delay for a retry."
|
|
137859
|
+
},
|
|
137860
|
+
"immutable": true,
|
|
137861
|
+
"locationInModule": {
|
|
137862
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
137863
|
+
"line": 60
|
|
137864
|
+
},
|
|
137865
|
+
"name": "minDelayTarget",
|
|
137866
|
+
"optional": true,
|
|
137867
|
+
"type": {
|
|
137868
|
+
"fqn": "terraconstructs.Duration"
|
|
137869
|
+
}
|
|
137870
|
+
},
|
|
137871
|
+
{
|
|
137872
|
+
"abstract": true,
|
|
137873
|
+
"docs": {
|
|
137874
|
+
"default": "0",
|
|
137875
|
+
"remarks": "Must be zero or greater",
|
|
137876
|
+
"stability": "stable",
|
|
137877
|
+
"summary": "The number of retries in the post-backoff phase, with the maximum delay between them."
|
|
137878
|
+
},
|
|
137879
|
+
"immutable": true,
|
|
137880
|
+
"locationInModule": {
|
|
137881
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
137882
|
+
"line": 94
|
|
137883
|
+
},
|
|
137884
|
+
"name": "numMaxDelayRetries",
|
|
137885
|
+
"optional": true,
|
|
137886
|
+
"type": {
|
|
137887
|
+
"primitive": "number"
|
|
137888
|
+
}
|
|
137889
|
+
},
|
|
137890
|
+
{
|
|
137891
|
+
"abstract": true,
|
|
137892
|
+
"docs": {
|
|
137893
|
+
"default": "0",
|
|
137894
|
+
"remarks": "Must be zero or greater",
|
|
137895
|
+
"stability": "stable",
|
|
137896
|
+
"summary": "The number of retries in the pre-backoff phase, with the specified minimum delay between them."
|
|
137897
|
+
},
|
|
137898
|
+
"immutable": true,
|
|
137899
|
+
"locationInModule": {
|
|
137900
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
137901
|
+
"line": 87
|
|
137902
|
+
},
|
|
137903
|
+
"name": "numMinDelayRetries",
|
|
137904
|
+
"optional": true,
|
|
137905
|
+
"type": {
|
|
137906
|
+
"primitive": "number"
|
|
137907
|
+
}
|
|
137908
|
+
},
|
|
137909
|
+
{
|
|
137910
|
+
"abstract": true,
|
|
137911
|
+
"docs": {
|
|
137912
|
+
"default": "0",
|
|
137913
|
+
"remarks": "Must be zero or greater.",
|
|
137914
|
+
"stability": "stable",
|
|
137915
|
+
"summary": "The number of retries to be done immediately, with no delay between them."
|
|
137916
|
+
},
|
|
137917
|
+
"immutable": true,
|
|
137918
|
+
"locationInModule": {
|
|
137919
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
137920
|
+
"line": 80
|
|
137921
|
+
},
|
|
137922
|
+
"name": "numNoDelayRetries",
|
|
137923
|
+
"optional": true,
|
|
137924
|
+
"type": {
|
|
137925
|
+
"primitive": "number"
|
|
137926
|
+
}
|
|
137927
|
+
},
|
|
137928
|
+
{
|
|
137929
|
+
"abstract": true,
|
|
137930
|
+
"docs": {
|
|
137931
|
+
"default": "3",
|
|
137932
|
+
"remarks": "Must be greater than or equal to zero and not exceed 100.",
|
|
137933
|
+
"stability": "stable",
|
|
137934
|
+
"summary": "The total number of retries, including immediate, pre-backoff, backoff, and post-backoff retries."
|
|
137935
|
+
},
|
|
137936
|
+
"immutable": true,
|
|
137937
|
+
"locationInModule": {
|
|
137938
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
137939
|
+
"line": 73
|
|
137940
|
+
},
|
|
137941
|
+
"name": "numRetries",
|
|
137942
|
+
"optional": true,
|
|
137943
|
+
"type": {
|
|
137944
|
+
"primitive": "number"
|
|
137945
|
+
}
|
|
137946
|
+
}
|
|
137947
|
+
],
|
|
137948
|
+
"symbolId": "src/aws/notify/delivery-policy:HealthyRetryPolicy"
|
|
137949
|
+
},
|
|
137365
137950
|
"terraconstructs.aws.notify.HttpMethod": {
|
|
137366
137951
|
"assembly": "terraconstructs",
|
|
137367
137952
|
"docs": {
|
|
@@ -137728,6 +138313,163 @@
|
|
|
137728
138313
|
],
|
|
137729
138314
|
"symbolId": "src/aws/notify/event-bus:IEventBus"
|
|
137730
138315
|
},
|
|
138316
|
+
"terraconstructs.aws.notify.INotificationRule": {
|
|
138317
|
+
"assembly": "terraconstructs",
|
|
138318
|
+
"docs": {
|
|
138319
|
+
"stability": "stable",
|
|
138320
|
+
"summary": "Represents a notification rule."
|
|
138321
|
+
},
|
|
138322
|
+
"fqn": "terraconstructs.aws.notify.INotificationRule",
|
|
138323
|
+
"interfaces": [
|
|
138324
|
+
"terraconstructs.aws.IAwsConstruct"
|
|
138325
|
+
],
|
|
138326
|
+
"kind": "interface",
|
|
138327
|
+
"locationInModule": {
|
|
138328
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
138329
|
+
"line": 104
|
|
138330
|
+
},
|
|
138331
|
+
"methods": [
|
|
138332
|
+
{
|
|
138333
|
+
"abstract": true,
|
|
138334
|
+
"docs": {
|
|
138335
|
+
"returns": "boolean - return true if it had any effect",
|
|
138336
|
+
"stability": "stable",
|
|
138337
|
+
"summary": "Adds target to notification rule."
|
|
138338
|
+
},
|
|
138339
|
+
"locationInModule": {
|
|
138340
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
138341
|
+
"line": 118
|
|
138342
|
+
},
|
|
138343
|
+
"name": "addTarget",
|
|
138344
|
+
"parameters": [
|
|
138345
|
+
{
|
|
138346
|
+
"docs": {
|
|
138347
|
+
"summary": "The SNS topic or AWS Chatbot Slack target."
|
|
138348
|
+
},
|
|
138349
|
+
"name": "target",
|
|
138350
|
+
"type": {
|
|
138351
|
+
"fqn": "terraconstructs.aws.notify.INotificationRuleTarget"
|
|
138352
|
+
}
|
|
138353
|
+
}
|
|
138354
|
+
],
|
|
138355
|
+
"returns": {
|
|
138356
|
+
"type": {
|
|
138357
|
+
"primitive": "boolean"
|
|
138358
|
+
}
|
|
138359
|
+
}
|
|
138360
|
+
}
|
|
138361
|
+
],
|
|
138362
|
+
"name": "INotificationRule",
|
|
138363
|
+
"namespace": "aws.notify",
|
|
138364
|
+
"properties": [
|
|
138365
|
+
{
|
|
138366
|
+
"abstract": true,
|
|
138367
|
+
"docs": {
|
|
138368
|
+
"custom": {
|
|
138369
|
+
"attribute": "true"
|
|
138370
|
+
},
|
|
138371
|
+
"stability": "stable",
|
|
138372
|
+
"summary": "The ARN of the notification rule (i.e. arn:aws:codestar-notifications:::notificationrule/01234abcde)."
|
|
138373
|
+
},
|
|
138374
|
+
"immutable": true,
|
|
138375
|
+
"locationInModule": {
|
|
138376
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
138377
|
+
"line": 110
|
|
138378
|
+
},
|
|
138379
|
+
"name": "notificationRuleArn",
|
|
138380
|
+
"type": {
|
|
138381
|
+
"primitive": "string"
|
|
138382
|
+
}
|
|
138383
|
+
}
|
|
138384
|
+
],
|
|
138385
|
+
"symbolId": "src/aws/notify/notification-rule:INotificationRule"
|
|
138386
|
+
},
|
|
138387
|
+
"terraconstructs.aws.notify.INotificationRuleSource": {
|
|
138388
|
+
"assembly": "terraconstructs",
|
|
138389
|
+
"docs": {
|
|
138390
|
+
"stability": "stable",
|
|
138391
|
+
"summary": "Represents a notification source The source that allows CodeBuild and CodePipeline to associate with this rule."
|
|
138392
|
+
},
|
|
138393
|
+
"fqn": "terraconstructs.aws.notify.INotificationRuleSource",
|
|
138394
|
+
"kind": "interface",
|
|
138395
|
+
"locationInModule": {
|
|
138396
|
+
"filename": "src/aws/notify/notification-rule-source.ts",
|
|
138397
|
+
"line": 19
|
|
138398
|
+
},
|
|
138399
|
+
"methods": [
|
|
138400
|
+
{
|
|
138401
|
+
"abstract": true,
|
|
138402
|
+
"docs": {
|
|
138403
|
+
"stability": "stable",
|
|
138404
|
+
"summary": "Returns a source configuration for notification rule."
|
|
138405
|
+
},
|
|
138406
|
+
"locationInModule": {
|
|
138407
|
+
"filename": "src/aws/notify/notification-rule-source.ts",
|
|
138408
|
+
"line": 23
|
|
138409
|
+
},
|
|
138410
|
+
"name": "bindAsNotificationRuleSource",
|
|
138411
|
+
"parameters": [
|
|
138412
|
+
{
|
|
138413
|
+
"name": "scope",
|
|
138414
|
+
"type": {
|
|
138415
|
+
"fqn": "constructs.Construct"
|
|
138416
|
+
}
|
|
138417
|
+
}
|
|
138418
|
+
],
|
|
138419
|
+
"returns": {
|
|
138420
|
+
"type": {
|
|
138421
|
+
"fqn": "terraconstructs.aws.notify.NotificationRuleSourceConfig"
|
|
138422
|
+
}
|
|
138423
|
+
}
|
|
138424
|
+
}
|
|
138425
|
+
],
|
|
138426
|
+
"name": "INotificationRuleSource",
|
|
138427
|
+
"namespace": "aws.notify",
|
|
138428
|
+
"symbolId": "src/aws/notify/notification-rule-source:INotificationRuleSource"
|
|
138429
|
+
},
|
|
138430
|
+
"terraconstructs.aws.notify.INotificationRuleTarget": {
|
|
138431
|
+
"assembly": "terraconstructs",
|
|
138432
|
+
"docs": {
|
|
138433
|
+
"stability": "stable",
|
|
138434
|
+
"summary": "Represents a notification target That allows AWS Chatbot and SNS topic to associate with this rule target."
|
|
138435
|
+
},
|
|
138436
|
+
"fqn": "terraconstructs.aws.notify.INotificationRuleTarget",
|
|
138437
|
+
"kind": "interface",
|
|
138438
|
+
"locationInModule": {
|
|
138439
|
+
"filename": "src/aws/notify/notification-rule-target.ts",
|
|
138440
|
+
"line": 24
|
|
138441
|
+
},
|
|
138442
|
+
"methods": [
|
|
138443
|
+
{
|
|
138444
|
+
"abstract": true,
|
|
138445
|
+
"docs": {
|
|
138446
|
+
"stability": "stable",
|
|
138447
|
+
"summary": "Returns a target configuration for notification rule."
|
|
138448
|
+
},
|
|
138449
|
+
"locationInModule": {
|
|
138450
|
+
"filename": "src/aws/notify/notification-rule-target.ts",
|
|
138451
|
+
"line": 28
|
|
138452
|
+
},
|
|
138453
|
+
"name": "bindAsNotificationRuleTarget",
|
|
138454
|
+
"parameters": [
|
|
138455
|
+
{
|
|
138456
|
+
"name": "scope",
|
|
138457
|
+
"type": {
|
|
138458
|
+
"fqn": "constructs.Construct"
|
|
138459
|
+
}
|
|
138460
|
+
}
|
|
138461
|
+
],
|
|
138462
|
+
"returns": {
|
|
138463
|
+
"type": {
|
|
138464
|
+
"fqn": "terraconstructs.aws.notify.NotificationRuleTargetConfig"
|
|
138465
|
+
}
|
|
138466
|
+
}
|
|
138467
|
+
}
|
|
138468
|
+
],
|
|
138469
|
+
"name": "INotificationRuleTarget",
|
|
138470
|
+
"namespace": "aws.notify",
|
|
138471
|
+
"symbolId": "src/aws/notify/notification-rule-target:INotificationRuleTarget"
|
|
138472
|
+
},
|
|
137731
138473
|
"terraconstructs.aws.notify.IQueue": {
|
|
137732
138474
|
"assembly": "terraconstructs",
|
|
137733
138475
|
"docs": {
|
|
@@ -139229,6 +139971,709 @@
|
|
|
139229
139971
|
],
|
|
139230
139972
|
"symbolId": "src/aws/notify/kinesis-stream:IStream"
|
|
139231
139973
|
},
|
|
139974
|
+
"terraconstructs.aws.notify.ITopic": {
|
|
139975
|
+
"assembly": "terraconstructs",
|
|
139976
|
+
"docs": {
|
|
139977
|
+
"stability": "stable",
|
|
139978
|
+
"summary": "Represents an SNS topic."
|
|
139979
|
+
},
|
|
139980
|
+
"fqn": "terraconstructs.aws.notify.ITopic",
|
|
139981
|
+
"interfaces": [
|
|
139982
|
+
"terraconstructs.aws.IAwsConstruct",
|
|
139983
|
+
"terraconstructs.aws.notify.INotificationRuleTarget"
|
|
139984
|
+
],
|
|
139985
|
+
"kind": "interface",
|
|
139986
|
+
"locationInModule": {
|
|
139987
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
139988
|
+
"line": 47
|
|
139989
|
+
},
|
|
139990
|
+
"methods": [
|
|
139991
|
+
{
|
|
139992
|
+
"abstract": true,
|
|
139993
|
+
"docs": {
|
|
139994
|
+
"stability": "stable",
|
|
139995
|
+
"summary": "Subscribe some endpoint to this topic."
|
|
139996
|
+
},
|
|
139997
|
+
"locationInModule": {
|
|
139998
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
139999
|
+
"line": 94
|
|
140000
|
+
},
|
|
140001
|
+
"name": "addSubscription",
|
|
140002
|
+
"parameters": [
|
|
140003
|
+
{
|
|
140004
|
+
"name": "subscription",
|
|
140005
|
+
"type": {
|
|
140006
|
+
"fqn": "terraconstructs.aws.notify.ITopicSubscription"
|
|
140007
|
+
}
|
|
140008
|
+
}
|
|
140009
|
+
],
|
|
140010
|
+
"returns": {
|
|
140011
|
+
"type": {
|
|
140012
|
+
"fqn": "terraconstructs.aws.notify.Subscription"
|
|
140013
|
+
}
|
|
140014
|
+
}
|
|
140015
|
+
},
|
|
140016
|
+
{
|
|
140017
|
+
"abstract": true,
|
|
140018
|
+
"docs": {
|
|
140019
|
+
"remarks": "If this topic was created in this stack (`new Topic`), a topic policy\nwill be automatically created upon the first call to `addToResourcePolicy`. If\nthe topic is imported (`Topic.import`), then this is a no-op.",
|
|
140020
|
+
"stability": "stable",
|
|
140021
|
+
"summary": "Adds a statement to the IAM resource policy associated with this topic."
|
|
140022
|
+
},
|
|
140023
|
+
"locationInModule": {
|
|
140024
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
140025
|
+
"line": 103
|
|
140026
|
+
},
|
|
140027
|
+
"name": "addToResourcePolicy",
|
|
140028
|
+
"parameters": [
|
|
140029
|
+
{
|
|
140030
|
+
"name": "statement",
|
|
140031
|
+
"type": {
|
|
140032
|
+
"fqn": "terraconstructs.aws.iam.PolicyStatement"
|
|
140033
|
+
}
|
|
140034
|
+
}
|
|
140035
|
+
],
|
|
140036
|
+
"returns": {
|
|
140037
|
+
"type": {
|
|
140038
|
+
"fqn": "terraconstructs.aws.iam.AddToResourcePolicyResult"
|
|
140039
|
+
}
|
|
140040
|
+
}
|
|
140041
|
+
},
|
|
140042
|
+
{
|
|
140043
|
+
"abstract": true,
|
|
140044
|
+
"docs": {
|
|
140045
|
+
"stability": "stable",
|
|
140046
|
+
"summary": "Grant topic publishing permissions to the given identity."
|
|
140047
|
+
},
|
|
140048
|
+
"locationInModule": {
|
|
140049
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
140050
|
+
"line": 110
|
|
140051
|
+
},
|
|
140052
|
+
"name": "grantPublish",
|
|
140053
|
+
"parameters": [
|
|
140054
|
+
{
|
|
140055
|
+
"name": "identity",
|
|
140056
|
+
"type": {
|
|
140057
|
+
"fqn": "terraconstructs.aws.iam.IGrantable"
|
|
140058
|
+
}
|
|
140059
|
+
}
|
|
140060
|
+
],
|
|
140061
|
+
"returns": {
|
|
140062
|
+
"type": {
|
|
140063
|
+
"fqn": "terraconstructs.aws.iam.Grant"
|
|
140064
|
+
}
|
|
140065
|
+
}
|
|
140066
|
+
},
|
|
140067
|
+
{
|
|
140068
|
+
"abstract": true,
|
|
140069
|
+
"docs": {
|
|
140070
|
+
"stability": "stable",
|
|
140071
|
+
"summary": "Grant topic subscribing permissions to the given identity."
|
|
140072
|
+
},
|
|
140073
|
+
"locationInModule": {
|
|
140074
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
140075
|
+
"line": 115
|
|
140076
|
+
},
|
|
140077
|
+
"name": "grantSubscribe",
|
|
140078
|
+
"parameters": [
|
|
140079
|
+
{
|
|
140080
|
+
"name": "identity",
|
|
140081
|
+
"type": {
|
|
140082
|
+
"fqn": "terraconstructs.aws.iam.IGrantable"
|
|
140083
|
+
}
|
|
140084
|
+
}
|
|
140085
|
+
],
|
|
140086
|
+
"returns": {
|
|
140087
|
+
"type": {
|
|
140088
|
+
"fqn": "terraconstructs.aws.iam.Grant"
|
|
140089
|
+
}
|
|
140090
|
+
}
|
|
140091
|
+
},
|
|
140092
|
+
{
|
|
140093
|
+
"abstract": true,
|
|
140094
|
+
"docs": {
|
|
140095
|
+
"stability": "stable",
|
|
140096
|
+
"summary": "Return the given named metric for this Topic."
|
|
140097
|
+
},
|
|
140098
|
+
"locationInModule": {
|
|
140099
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
140100
|
+
"line": 11
|
|
140101
|
+
},
|
|
140102
|
+
"name": "metric",
|
|
140103
|
+
"parameters": [
|
|
140104
|
+
{
|
|
140105
|
+
"name": "metricName",
|
|
140106
|
+
"type": {
|
|
140107
|
+
"primitive": "string"
|
|
140108
|
+
}
|
|
140109
|
+
},
|
|
140110
|
+
{
|
|
140111
|
+
"name": "props",
|
|
140112
|
+
"optional": true,
|
|
140113
|
+
"type": {
|
|
140114
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
140115
|
+
}
|
|
140116
|
+
}
|
|
140117
|
+
],
|
|
140118
|
+
"returns": {
|
|
140119
|
+
"type": {
|
|
140120
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
140121
|
+
}
|
|
140122
|
+
}
|
|
140123
|
+
},
|
|
140124
|
+
{
|
|
140125
|
+
"abstract": true,
|
|
140126
|
+
"docs": {
|
|
140127
|
+
"remarks": "Sum over 5 minutes",
|
|
140128
|
+
"stability": "stable",
|
|
140129
|
+
"summary": "The number of messages published to your Amazon SNS topics."
|
|
140130
|
+
},
|
|
140131
|
+
"locationInModule": {
|
|
140132
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
140133
|
+
"line": 25
|
|
140134
|
+
},
|
|
140135
|
+
"name": "metricNumberOfMessagesPublished",
|
|
140136
|
+
"parameters": [
|
|
140137
|
+
{
|
|
140138
|
+
"name": "props",
|
|
140139
|
+
"optional": true,
|
|
140140
|
+
"type": {
|
|
140141
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
140142
|
+
}
|
|
140143
|
+
}
|
|
140144
|
+
],
|
|
140145
|
+
"returns": {
|
|
140146
|
+
"type": {
|
|
140147
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
140148
|
+
}
|
|
140149
|
+
}
|
|
140150
|
+
},
|
|
140151
|
+
{
|
|
140152
|
+
"abstract": true,
|
|
140153
|
+
"docs": {
|
|
140154
|
+
"remarks": "Sum over 5 minutes",
|
|
140155
|
+
"stability": "stable",
|
|
140156
|
+
"summary": "The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints."
|
|
140157
|
+
},
|
|
140158
|
+
"locationInModule": {
|
|
140159
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
140160
|
+
"line": 32
|
|
140161
|
+
},
|
|
140162
|
+
"name": "metricNumberOfNotificationsDelivered",
|
|
140163
|
+
"parameters": [
|
|
140164
|
+
{
|
|
140165
|
+
"name": "props",
|
|
140166
|
+
"optional": true,
|
|
140167
|
+
"type": {
|
|
140168
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
140169
|
+
}
|
|
140170
|
+
}
|
|
140171
|
+
],
|
|
140172
|
+
"returns": {
|
|
140173
|
+
"type": {
|
|
140174
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
140175
|
+
}
|
|
140176
|
+
}
|
|
140177
|
+
},
|
|
140178
|
+
{
|
|
140179
|
+
"abstract": true,
|
|
140180
|
+
"docs": {
|
|
140181
|
+
"remarks": "Sum over 5 minutes",
|
|
140182
|
+
"stability": "stable",
|
|
140183
|
+
"summary": "The number of messages that Amazon SNS failed to deliver."
|
|
140184
|
+
},
|
|
140185
|
+
"locationInModule": {
|
|
140186
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
140187
|
+
"line": 39
|
|
140188
|
+
},
|
|
140189
|
+
"name": "metricNumberOfNotificationsFailed",
|
|
140190
|
+
"parameters": [
|
|
140191
|
+
{
|
|
140192
|
+
"name": "props",
|
|
140193
|
+
"optional": true,
|
|
140194
|
+
"type": {
|
|
140195
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
140196
|
+
}
|
|
140197
|
+
}
|
|
140198
|
+
],
|
|
140199
|
+
"returns": {
|
|
140200
|
+
"type": {
|
|
140201
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
140202
|
+
}
|
|
140203
|
+
}
|
|
140204
|
+
},
|
|
140205
|
+
{
|
|
140206
|
+
"abstract": true,
|
|
140207
|
+
"docs": {
|
|
140208
|
+
"remarks": "Sum over 5 minutes",
|
|
140209
|
+
"stability": "stable",
|
|
140210
|
+
"summary": "The number of messages that were rejected by subscription filter policies."
|
|
140211
|
+
},
|
|
140212
|
+
"locationInModule": {
|
|
140213
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
140214
|
+
"line": 46
|
|
140215
|
+
},
|
|
140216
|
+
"name": "metricNumberOfNotificationsFilteredOut",
|
|
140217
|
+
"parameters": [
|
|
140218
|
+
{
|
|
140219
|
+
"name": "props",
|
|
140220
|
+
"optional": true,
|
|
140221
|
+
"type": {
|
|
140222
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
140223
|
+
}
|
|
140224
|
+
}
|
|
140225
|
+
],
|
|
140226
|
+
"returns": {
|
|
140227
|
+
"type": {
|
|
140228
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
140229
|
+
}
|
|
140230
|
+
}
|
|
140231
|
+
},
|
|
140232
|
+
{
|
|
140233
|
+
"abstract": true,
|
|
140234
|
+
"docs": {
|
|
140235
|
+
"remarks": "Sum over 5 minutes",
|
|
140236
|
+
"stability": "stable",
|
|
140237
|
+
"summary": "The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid."
|
|
140238
|
+
},
|
|
140239
|
+
"locationInModule": {
|
|
140240
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
140241
|
+
"line": 60
|
|
140242
|
+
},
|
|
140243
|
+
"name": "metricNumberOfNotificationsFilteredOutInvalidAttributes",
|
|
140244
|
+
"parameters": [
|
|
140245
|
+
{
|
|
140246
|
+
"name": "props",
|
|
140247
|
+
"optional": true,
|
|
140248
|
+
"type": {
|
|
140249
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
140250
|
+
}
|
|
140251
|
+
}
|
|
140252
|
+
],
|
|
140253
|
+
"returns": {
|
|
140254
|
+
"type": {
|
|
140255
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
140256
|
+
}
|
|
140257
|
+
}
|
|
140258
|
+
},
|
|
140259
|
+
{
|
|
140260
|
+
"abstract": true,
|
|
140261
|
+
"docs": {
|
|
140262
|
+
"remarks": "Sum over 5 minutes",
|
|
140263
|
+
"stability": "stable",
|
|
140264
|
+
"summary": "The number of messages that were rejected by subscription filter policies because the messages have no attributes."
|
|
140265
|
+
},
|
|
140266
|
+
"locationInModule": {
|
|
140267
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
140268
|
+
"line": 53
|
|
140269
|
+
},
|
|
140270
|
+
"name": "metricNumberOfNotificationsFilteredOutNoMessageAttributes",
|
|
140271
|
+
"parameters": [
|
|
140272
|
+
{
|
|
140273
|
+
"name": "props",
|
|
140274
|
+
"optional": true,
|
|
140275
|
+
"type": {
|
|
140276
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
140277
|
+
}
|
|
140278
|
+
}
|
|
140279
|
+
],
|
|
140280
|
+
"returns": {
|
|
140281
|
+
"type": {
|
|
140282
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
140283
|
+
}
|
|
140284
|
+
}
|
|
140285
|
+
},
|
|
140286
|
+
{
|
|
140287
|
+
"abstract": true,
|
|
140288
|
+
"docs": {
|
|
140289
|
+
"remarks": "Average over 5 minutes",
|
|
140290
|
+
"stability": "stable",
|
|
140291
|
+
"summary": "Metric for the size of messages published through this topic."
|
|
140292
|
+
},
|
|
140293
|
+
"locationInModule": {
|
|
140294
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
140295
|
+
"line": 18
|
|
140296
|
+
},
|
|
140297
|
+
"name": "metricPublishSize",
|
|
140298
|
+
"parameters": [
|
|
140299
|
+
{
|
|
140300
|
+
"name": "props",
|
|
140301
|
+
"optional": true,
|
|
140302
|
+
"type": {
|
|
140303
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
140304
|
+
}
|
|
140305
|
+
}
|
|
140306
|
+
],
|
|
140307
|
+
"returns": {
|
|
140308
|
+
"type": {
|
|
140309
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
140310
|
+
}
|
|
140311
|
+
}
|
|
140312
|
+
},
|
|
140313
|
+
{
|
|
140314
|
+
"abstract": true,
|
|
140315
|
+
"docs": {
|
|
140316
|
+
"remarks": "Maximum over 5 minutes",
|
|
140317
|
+
"stability": "stable",
|
|
140318
|
+
"summary": "The charges you have accrued since the start of the current calendar month for sending SMS messages."
|
|
140319
|
+
},
|
|
140320
|
+
"locationInModule": {
|
|
140321
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
140322
|
+
"line": 67
|
|
140323
|
+
},
|
|
140324
|
+
"name": "metricSMSMonthToDateSpentUSD",
|
|
140325
|
+
"parameters": [
|
|
140326
|
+
{
|
|
140327
|
+
"name": "props",
|
|
140328
|
+
"optional": true,
|
|
140329
|
+
"type": {
|
|
140330
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
140331
|
+
}
|
|
140332
|
+
}
|
|
140333
|
+
],
|
|
140334
|
+
"returns": {
|
|
140335
|
+
"type": {
|
|
140336
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
140337
|
+
}
|
|
140338
|
+
}
|
|
140339
|
+
},
|
|
140340
|
+
{
|
|
140341
|
+
"abstract": true,
|
|
140342
|
+
"docs": {
|
|
140343
|
+
"remarks": "Sum over 5 minutes",
|
|
140344
|
+
"stability": "stable",
|
|
140345
|
+
"summary": "The rate of successful SMS message deliveries."
|
|
140346
|
+
},
|
|
140347
|
+
"locationInModule": {
|
|
140348
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
140349
|
+
"line": 74
|
|
140350
|
+
},
|
|
140351
|
+
"name": "metricSMSSuccessRate",
|
|
140352
|
+
"parameters": [
|
|
140353
|
+
{
|
|
140354
|
+
"name": "props",
|
|
140355
|
+
"optional": true,
|
|
140356
|
+
"type": {
|
|
140357
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
140358
|
+
}
|
|
140359
|
+
}
|
|
140360
|
+
],
|
|
140361
|
+
"returns": {
|
|
140362
|
+
"type": {
|
|
140363
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
140364
|
+
}
|
|
140365
|
+
}
|
|
140366
|
+
}
|
|
140367
|
+
],
|
|
140368
|
+
"name": "ITopic",
|
|
140369
|
+
"namespace": "aws.notify",
|
|
140370
|
+
"properties": [
|
|
140371
|
+
{
|
|
140372
|
+
"abstract": true,
|
|
140373
|
+
"docs": {
|
|
140374
|
+
"custom": {
|
|
140375
|
+
"attribute": "true"
|
|
140376
|
+
},
|
|
140377
|
+
"stability": "stable",
|
|
140378
|
+
"summary": "Enables content-based deduplication for FIFO topics."
|
|
140379
|
+
},
|
|
140380
|
+
"immutable": true,
|
|
140381
|
+
"locationInModule": {
|
|
140382
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
140383
|
+
"line": 82
|
|
140384
|
+
},
|
|
140385
|
+
"name": "contentBasedDeduplication",
|
|
140386
|
+
"type": {
|
|
140387
|
+
"primitive": "boolean"
|
|
140388
|
+
}
|
|
140389
|
+
},
|
|
140390
|
+
{
|
|
140391
|
+
"abstract": true,
|
|
140392
|
+
"docs": {
|
|
140393
|
+
"custom": {
|
|
140394
|
+
"attribute": "true"
|
|
140395
|
+
},
|
|
140396
|
+
"remarks": "If false, this is a standard topic.",
|
|
140397
|
+
"stability": "stable",
|
|
140398
|
+
"summary": "Whether this topic is an Amazon SNS FIFO queue."
|
|
140399
|
+
},
|
|
140400
|
+
"immutable": true,
|
|
140401
|
+
"locationInModule": {
|
|
140402
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
140403
|
+
"line": 89
|
|
140404
|
+
},
|
|
140405
|
+
"name": "fifo",
|
|
140406
|
+
"type": {
|
|
140407
|
+
"primitive": "boolean"
|
|
140408
|
+
}
|
|
140409
|
+
},
|
|
140410
|
+
{
|
|
140411
|
+
"abstract": true,
|
|
140412
|
+
"docs": {
|
|
140413
|
+
"custom": {
|
|
140414
|
+
"attribute": "true"
|
|
140415
|
+
},
|
|
140416
|
+
"stability": "stable",
|
|
140417
|
+
"summary": "The ARN of the topic."
|
|
140418
|
+
},
|
|
140419
|
+
"immutable": true,
|
|
140420
|
+
"locationInModule": {
|
|
140421
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
140422
|
+
"line": 57
|
|
140423
|
+
},
|
|
140424
|
+
"name": "topicArn",
|
|
140425
|
+
"type": {
|
|
140426
|
+
"primitive": "string"
|
|
140427
|
+
}
|
|
140428
|
+
},
|
|
140429
|
+
{
|
|
140430
|
+
"abstract": true,
|
|
140431
|
+
"docs": {
|
|
140432
|
+
"custom": {
|
|
140433
|
+
"attribute": "true"
|
|
140434
|
+
},
|
|
140435
|
+
"stability": "stable",
|
|
140436
|
+
"summary": "The name of the topic."
|
|
140437
|
+
},
|
|
140438
|
+
"immutable": true,
|
|
140439
|
+
"locationInModule": {
|
|
140440
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
140441
|
+
"line": 64
|
|
140442
|
+
},
|
|
140443
|
+
"name": "topicName",
|
|
140444
|
+
"type": {
|
|
140445
|
+
"primitive": "string"
|
|
140446
|
+
}
|
|
140447
|
+
},
|
|
140448
|
+
{
|
|
140449
|
+
"abstract": true,
|
|
140450
|
+
"docs": {
|
|
140451
|
+
"stability": "stable",
|
|
140452
|
+
"summary": "strongly typed outputs for the topic."
|
|
140453
|
+
},
|
|
140454
|
+
"immutable": true,
|
|
140455
|
+
"locationInModule": {
|
|
140456
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
140457
|
+
"line": 51
|
|
140458
|
+
},
|
|
140459
|
+
"name": "topicOutputs",
|
|
140460
|
+
"type": {
|
|
140461
|
+
"fqn": "terraconstructs.aws.notify.TopicOutputs"
|
|
140462
|
+
}
|
|
140463
|
+
},
|
|
140464
|
+
{
|
|
140465
|
+
"abstract": true,
|
|
140466
|
+
"docs": {
|
|
140467
|
+
"default": "None",
|
|
140468
|
+
"remarks": "This property applies only to server-side encryption.",
|
|
140469
|
+
"see": "https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html",
|
|
140470
|
+
"stability": "stable",
|
|
140471
|
+
"summary": "A KMS Key, either managed by this CDK app, or imported."
|
|
140472
|
+
},
|
|
140473
|
+
"immutable": true,
|
|
140474
|
+
"locationInModule": {
|
|
140475
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
140476
|
+
"line": 75
|
|
140477
|
+
},
|
|
140478
|
+
"name": "masterKey",
|
|
140479
|
+
"optional": true,
|
|
140480
|
+
"type": {
|
|
140481
|
+
"fqn": "terraconstructs.aws.encryption.IKey"
|
|
140482
|
+
}
|
|
140483
|
+
}
|
|
140484
|
+
],
|
|
140485
|
+
"symbolId": "src/aws/notify/topic-base:ITopic"
|
|
140486
|
+
},
|
|
140487
|
+
"terraconstructs.aws.notify.ITopicSubscription": {
|
|
140488
|
+
"assembly": "terraconstructs",
|
|
140489
|
+
"docs": {
|
|
140490
|
+
"stability": "stable",
|
|
140491
|
+
"summary": "Topic subscription."
|
|
140492
|
+
},
|
|
140493
|
+
"fqn": "terraconstructs.aws.notify.ITopicSubscription",
|
|
140494
|
+
"kind": "interface",
|
|
140495
|
+
"locationInModule": {
|
|
140496
|
+
"filename": "src/aws/notify/subscriber.ts",
|
|
140497
|
+
"line": 43
|
|
140498
|
+
},
|
|
140499
|
+
"methods": [
|
|
140500
|
+
{
|
|
140501
|
+
"abstract": true,
|
|
140502
|
+
"docs": {
|
|
140503
|
+
"stability": "stable",
|
|
140504
|
+
"summary": "Returns a configuration used to subscribe to an SNS topic."
|
|
140505
|
+
},
|
|
140506
|
+
"locationInModule": {
|
|
140507
|
+
"filename": "src/aws/notify/subscriber.ts",
|
|
140508
|
+
"line": 49
|
|
140509
|
+
},
|
|
140510
|
+
"name": "bind",
|
|
140511
|
+
"parameters": [
|
|
140512
|
+
{
|
|
140513
|
+
"docs": {
|
|
140514
|
+
"summary": "topic for which subscription will be configured."
|
|
140515
|
+
},
|
|
140516
|
+
"name": "topic",
|
|
140517
|
+
"type": {
|
|
140518
|
+
"fqn": "terraconstructs.aws.notify.ITopic"
|
|
140519
|
+
}
|
|
140520
|
+
}
|
|
140521
|
+
],
|
|
140522
|
+
"returns": {
|
|
140523
|
+
"type": {
|
|
140524
|
+
"fqn": "terraconstructs.aws.notify.TopicSubscriptionConfig"
|
|
140525
|
+
}
|
|
140526
|
+
}
|
|
140527
|
+
}
|
|
140528
|
+
],
|
|
140529
|
+
"name": "ITopicSubscription",
|
|
140530
|
+
"namespace": "aws.notify",
|
|
140531
|
+
"symbolId": "src/aws/notify/subscriber:ITopicSubscription"
|
|
140532
|
+
},
|
|
140533
|
+
"terraconstructs.aws.notify.LoggingConfig": {
|
|
140534
|
+
"assembly": "terraconstructs",
|
|
140535
|
+
"datatype": true,
|
|
140536
|
+
"docs": {
|
|
140537
|
+
"see": "https://docs.aws.amazon.com/sns/latest/dg/sns-topic-attributes.html.",
|
|
140538
|
+
"stability": "stable",
|
|
140539
|
+
"summary": "A logging configuration for delivery status of messages sent from SNS topic to subscribed endpoints."
|
|
140540
|
+
},
|
|
140541
|
+
"fqn": "terraconstructs.aws.notify.LoggingConfig",
|
|
140542
|
+
"kind": "interface",
|
|
140543
|
+
"locationInModule": {
|
|
140544
|
+
"filename": "src/aws/notify/topic.ts",
|
|
140545
|
+
"line": 142
|
|
140546
|
+
},
|
|
140547
|
+
"name": "LoggingConfig",
|
|
140548
|
+
"namespace": "aws.notify",
|
|
140549
|
+
"properties": [
|
|
140550
|
+
{
|
|
140551
|
+
"abstract": true,
|
|
140552
|
+
"docs": {
|
|
140553
|
+
"stability": "stable",
|
|
140554
|
+
"summary": "Indicates one of the supported protocols for the SNS topic."
|
|
140555
|
+
},
|
|
140556
|
+
"immutable": true,
|
|
140557
|
+
"locationInModule": {
|
|
140558
|
+
"filename": "src/aws/notify/topic.ts",
|
|
140559
|
+
"line": 146
|
|
140560
|
+
},
|
|
140561
|
+
"name": "protocol",
|
|
140562
|
+
"type": {
|
|
140563
|
+
"fqn": "terraconstructs.aws.notify.LoggingProtocol"
|
|
140564
|
+
}
|
|
140565
|
+
},
|
|
140566
|
+
{
|
|
140567
|
+
"abstract": true,
|
|
140568
|
+
"docs": {
|
|
140569
|
+
"default": "None",
|
|
140570
|
+
"stability": "stable",
|
|
140571
|
+
"summary": "The IAM role to be used when logging failed message deliveries in Amazon CloudWatch."
|
|
140572
|
+
},
|
|
140573
|
+
"immutable": true,
|
|
140574
|
+
"locationInModule": {
|
|
140575
|
+
"filename": "src/aws/notify/topic.ts",
|
|
140576
|
+
"line": 153
|
|
140577
|
+
},
|
|
140578
|
+
"name": "failureFeedbackRole",
|
|
140579
|
+
"optional": true,
|
|
140580
|
+
"type": {
|
|
140581
|
+
"fqn": "terraconstructs.aws.iam.IRole"
|
|
140582
|
+
}
|
|
140583
|
+
},
|
|
140584
|
+
{
|
|
140585
|
+
"abstract": true,
|
|
140586
|
+
"docs": {
|
|
140587
|
+
"default": "None",
|
|
140588
|
+
"stability": "stable",
|
|
140589
|
+
"summary": "The IAM role to be used when logging successful message deliveries in Amazon CloudWatch."
|
|
140590
|
+
},
|
|
140591
|
+
"immutable": true,
|
|
140592
|
+
"locationInModule": {
|
|
140593
|
+
"filename": "src/aws/notify/topic.ts",
|
|
140594
|
+
"line": 160
|
|
140595
|
+
},
|
|
140596
|
+
"name": "successFeedbackRole",
|
|
140597
|
+
"optional": true,
|
|
140598
|
+
"type": {
|
|
140599
|
+
"fqn": "terraconstructs.aws.iam.IRole"
|
|
140600
|
+
}
|
|
140601
|
+
},
|
|
140602
|
+
{
|
|
140603
|
+
"abstract": true,
|
|
140604
|
+
"docs": {
|
|
140605
|
+
"default": "None",
|
|
140606
|
+
"remarks": "Valid values are integer between 0-100",
|
|
140607
|
+
"stability": "stable",
|
|
140608
|
+
"summary": "The percentage of successful message deliveries to be logged in Amazon CloudWatch."
|
|
140609
|
+
},
|
|
140610
|
+
"immutable": true,
|
|
140611
|
+
"locationInModule": {
|
|
140612
|
+
"filename": "src/aws/notify/topic.ts",
|
|
140613
|
+
"line": 169
|
|
140614
|
+
},
|
|
140615
|
+
"name": "successFeedbackSampleRate",
|
|
140616
|
+
"optional": true,
|
|
140617
|
+
"type": {
|
|
140618
|
+
"primitive": "number"
|
|
140619
|
+
}
|
|
140620
|
+
}
|
|
140621
|
+
],
|
|
140622
|
+
"symbolId": "src/aws/notify/topic:LoggingConfig"
|
|
140623
|
+
},
|
|
140624
|
+
"terraconstructs.aws.notify.LoggingProtocol": {
|
|
140625
|
+
"assembly": "terraconstructs",
|
|
140626
|
+
"docs": {
|
|
140627
|
+
"stability": "stable",
|
|
140628
|
+
"summary": "The type of supported protocol for delivery status logging."
|
|
140629
|
+
},
|
|
140630
|
+
"fqn": "terraconstructs.aws.notify.LoggingProtocol",
|
|
140631
|
+
"kind": "enum",
|
|
140632
|
+
"locationInModule": {
|
|
140633
|
+
"filename": "src/aws/notify/topic.ts",
|
|
140634
|
+
"line": 175
|
|
140635
|
+
},
|
|
140636
|
+
"members": [
|
|
140637
|
+
{
|
|
140638
|
+
"docs": {
|
|
140639
|
+
"stability": "stable",
|
|
140640
|
+
"summary": "HTTP."
|
|
140641
|
+
},
|
|
140642
|
+
"name": "HTTP"
|
|
140643
|
+
},
|
|
140644
|
+
{
|
|
140645
|
+
"docs": {
|
|
140646
|
+
"stability": "stable",
|
|
140647
|
+
"summary": "Amazon Simple Queue Service."
|
|
140648
|
+
},
|
|
140649
|
+
"name": "SQS"
|
|
140650
|
+
},
|
|
140651
|
+
{
|
|
140652
|
+
"docs": {
|
|
140653
|
+
"stability": "stable",
|
|
140654
|
+
"summary": "AWS Lambda."
|
|
140655
|
+
},
|
|
140656
|
+
"name": "LAMBDA"
|
|
140657
|
+
},
|
|
140658
|
+
{
|
|
140659
|
+
"docs": {
|
|
140660
|
+
"stability": "stable",
|
|
140661
|
+
"summary": "Amazon Data Firehose."
|
|
140662
|
+
},
|
|
140663
|
+
"name": "FIREHOSE"
|
|
140664
|
+
},
|
|
140665
|
+
{
|
|
140666
|
+
"docs": {
|
|
140667
|
+
"stability": "stable",
|
|
140668
|
+
"summary": "Platform application endpoint."
|
|
140669
|
+
},
|
|
140670
|
+
"name": "APPLICATION"
|
|
140671
|
+
}
|
|
140672
|
+
],
|
|
140673
|
+
"name": "LoggingProtocol",
|
|
140674
|
+
"namespace": "aws.notify",
|
|
140675
|
+
"symbolId": "src/aws/notify/topic:LoggingProtocol"
|
|
140676
|
+
},
|
|
139232
140677
|
"terraconstructs.aws.notify.Match": {
|
|
139233
140678
|
"assembly": "terraconstructs",
|
|
139234
140679
|
"docs": {
|
|
@@ -140094,6 +141539,619 @@
|
|
|
140094
141539
|
],
|
|
140095
141540
|
"symbolId": "src/aws/notify/event-pattern:Match"
|
|
140096
141541
|
},
|
|
141542
|
+
"terraconstructs.aws.notify.NotificationRule": {
|
|
141543
|
+
"assembly": "terraconstructs",
|
|
141544
|
+
"base": "terraconstructs.aws.AwsConstructBase",
|
|
141545
|
+
"docs": {
|
|
141546
|
+
"custom": {
|
|
141547
|
+
"resource": "AWS::CodeStarNotifications::NotificationRule"
|
|
141548
|
+
},
|
|
141549
|
+
"stability": "stable",
|
|
141550
|
+
"summary": "A new notification rule."
|
|
141551
|
+
},
|
|
141552
|
+
"fqn": "terraconstructs.aws.notify.NotificationRule",
|
|
141553
|
+
"initializer": {
|
|
141554
|
+
"docs": {
|
|
141555
|
+
"stability": "stable"
|
|
141556
|
+
},
|
|
141557
|
+
"locationInModule": {
|
|
141558
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141559
|
+
"line": 173
|
|
141560
|
+
},
|
|
141561
|
+
"parameters": [
|
|
141562
|
+
{
|
|
141563
|
+
"name": "scope",
|
|
141564
|
+
"type": {
|
|
141565
|
+
"fqn": "constructs.Construct"
|
|
141566
|
+
}
|
|
141567
|
+
},
|
|
141568
|
+
{
|
|
141569
|
+
"name": "id",
|
|
141570
|
+
"type": {
|
|
141571
|
+
"primitive": "string"
|
|
141572
|
+
}
|
|
141573
|
+
},
|
|
141574
|
+
{
|
|
141575
|
+
"name": "props",
|
|
141576
|
+
"type": {
|
|
141577
|
+
"fqn": "terraconstructs.aws.notify.NotificationRuleProps"
|
|
141578
|
+
}
|
|
141579
|
+
}
|
|
141580
|
+
]
|
|
141581
|
+
},
|
|
141582
|
+
"interfaces": [
|
|
141583
|
+
"terraconstructs.aws.notify.INotificationRule"
|
|
141584
|
+
],
|
|
141585
|
+
"kind": "class",
|
|
141586
|
+
"locationInModule": {
|
|
141587
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141588
|
+
"line": 126
|
|
141589
|
+
},
|
|
141590
|
+
"methods": [
|
|
141591
|
+
{
|
|
141592
|
+
"docs": {
|
|
141593
|
+
"stability": "stable",
|
|
141594
|
+
"summary": "Import an existing notification rule provided an ARN."
|
|
141595
|
+
},
|
|
141596
|
+
"locationInModule": {
|
|
141597
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141598
|
+
"line": 136
|
|
141599
|
+
},
|
|
141600
|
+
"name": "fromNotificationRuleArn",
|
|
141601
|
+
"parameters": [
|
|
141602
|
+
{
|
|
141603
|
+
"docs": {
|
|
141604
|
+
"summary": "The parent creating construct."
|
|
141605
|
+
},
|
|
141606
|
+
"name": "scope",
|
|
141607
|
+
"type": {
|
|
141608
|
+
"fqn": "constructs.Construct"
|
|
141609
|
+
}
|
|
141610
|
+
},
|
|
141611
|
+
{
|
|
141612
|
+
"docs": {
|
|
141613
|
+
"summary": "The construct's name."
|
|
141614
|
+
},
|
|
141615
|
+
"name": "id",
|
|
141616
|
+
"type": {
|
|
141617
|
+
"primitive": "string"
|
|
141618
|
+
}
|
|
141619
|
+
},
|
|
141620
|
+
{
|
|
141621
|
+
"docs": {
|
|
141622
|
+
"summary": "Notification rule ARN (i.e. arn:aws:codestar-notifications:::notificationrule/01234abcde)."
|
|
141623
|
+
},
|
|
141624
|
+
"name": "notificationRuleArn",
|
|
141625
|
+
"type": {
|
|
141626
|
+
"primitive": "string"
|
|
141627
|
+
}
|
|
141628
|
+
}
|
|
141629
|
+
],
|
|
141630
|
+
"returns": {
|
|
141631
|
+
"type": {
|
|
141632
|
+
"fqn": "terraconstructs.aws.notify.INotificationRule"
|
|
141633
|
+
}
|
|
141634
|
+
},
|
|
141635
|
+
"static": true
|
|
141636
|
+
},
|
|
141637
|
+
{
|
|
141638
|
+
"docs": {
|
|
141639
|
+
"stability": "stable",
|
|
141640
|
+
"summary": "Adds target to notification rule."
|
|
141641
|
+
},
|
|
141642
|
+
"locationInModule": {
|
|
141643
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141644
|
+
"line": 234
|
|
141645
|
+
},
|
|
141646
|
+
"name": "addTarget",
|
|
141647
|
+
"overrides": "terraconstructs.aws.notify.INotificationRule",
|
|
141648
|
+
"parameters": [
|
|
141649
|
+
{
|
|
141650
|
+
"name": "target",
|
|
141651
|
+
"type": {
|
|
141652
|
+
"fqn": "terraconstructs.aws.notify.INotificationRuleTarget"
|
|
141653
|
+
}
|
|
141654
|
+
}
|
|
141655
|
+
],
|
|
141656
|
+
"returns": {
|
|
141657
|
+
"type": {
|
|
141658
|
+
"primitive": "boolean"
|
|
141659
|
+
}
|
|
141660
|
+
}
|
|
141661
|
+
}
|
|
141662
|
+
],
|
|
141663
|
+
"name": "NotificationRule",
|
|
141664
|
+
"namespace": "aws.notify",
|
|
141665
|
+
"properties": [
|
|
141666
|
+
{
|
|
141667
|
+
"docs": {
|
|
141668
|
+
"custom": {
|
|
141669
|
+
"attribute": "true"
|
|
141670
|
+
},
|
|
141671
|
+
"stability": "stable",
|
|
141672
|
+
"summary": "The ARN of the notification rule (i.e. arn:aws:codestar-notifications:::notificationrule/01234abcde)."
|
|
141673
|
+
},
|
|
141674
|
+
"immutable": true,
|
|
141675
|
+
"locationInModule": {
|
|
141676
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141677
|
+
"line": 163
|
|
141678
|
+
},
|
|
141679
|
+
"name": "notificationRuleArn",
|
|
141680
|
+
"overrides": "terraconstructs.aws.notify.INotificationRule",
|
|
141681
|
+
"type": {
|
|
141682
|
+
"primitive": "string"
|
|
141683
|
+
}
|
|
141684
|
+
},
|
|
141685
|
+
{
|
|
141686
|
+
"docs": {
|
|
141687
|
+
"stability": "stable",
|
|
141688
|
+
"summary": "Outputs to register with the parent Scope or undefined if there are no outputs."
|
|
141689
|
+
},
|
|
141690
|
+
"immutable": true,
|
|
141691
|
+
"locationInModule": {
|
|
141692
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141693
|
+
"line": 169
|
|
141694
|
+
},
|
|
141695
|
+
"name": "outputs",
|
|
141696
|
+
"overrides": "terraconstructs.TerraConstructBase",
|
|
141697
|
+
"type": {
|
|
141698
|
+
"collection": {
|
|
141699
|
+
"elementtype": {
|
|
141700
|
+
"primitive": "any"
|
|
141701
|
+
},
|
|
141702
|
+
"kind": "map"
|
|
141703
|
+
}
|
|
141704
|
+
}
|
|
141705
|
+
}
|
|
141706
|
+
],
|
|
141707
|
+
"symbolId": "src/aws/notify/notification-rule:NotificationRule"
|
|
141708
|
+
},
|
|
141709
|
+
"terraconstructs.aws.notify.NotificationRuleOptions": {
|
|
141710
|
+
"assembly": "terraconstructs",
|
|
141711
|
+
"datatype": true,
|
|
141712
|
+
"docs": {
|
|
141713
|
+
"stability": "stable",
|
|
141714
|
+
"summary": "Standard set of options for `notifyOnXxx` codestar notification handler on construct."
|
|
141715
|
+
},
|
|
141716
|
+
"fqn": "terraconstructs.aws.notify.NotificationRuleOptions",
|
|
141717
|
+
"kind": "interface",
|
|
141718
|
+
"locationInModule": {
|
|
141719
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141720
|
+
"line": 31
|
|
141721
|
+
},
|
|
141722
|
+
"name": "NotificationRuleOptions",
|
|
141723
|
+
"namespace": "aws.notify",
|
|
141724
|
+
"properties": [
|
|
141725
|
+
{
|
|
141726
|
+
"abstract": true,
|
|
141727
|
+
"docs": {
|
|
141728
|
+
"default": "DetailType.FULL",
|
|
141729
|
+
"remarks": "BASIC will include only the contents of the event as it would appear in AWS CloudWatch.\nFULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.",
|
|
141730
|
+
"stability": "stable",
|
|
141731
|
+
"summary": "The level of detail to include in the notifications for this resource."
|
|
141732
|
+
},
|
|
141733
|
+
"immutable": true,
|
|
141734
|
+
"locationInModule": {
|
|
141735
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141736
|
+
"line": 55
|
|
141737
|
+
},
|
|
141738
|
+
"name": "detailType",
|
|
141739
|
+
"optional": true,
|
|
141740
|
+
"type": {
|
|
141741
|
+
"fqn": "terraconstructs.aws.notify.DetailType"
|
|
141742
|
+
}
|
|
141743
|
+
},
|
|
141744
|
+
{
|
|
141745
|
+
"abstract": true,
|
|
141746
|
+
"docs": {
|
|
141747
|
+
"default": "true",
|
|
141748
|
+
"remarks": "If the enabled is set to DISABLED, notifications aren't sent for the notification rule.",
|
|
141749
|
+
"stability": "stable",
|
|
141750
|
+
"summary": "The status of the notification rule."
|
|
141751
|
+
},
|
|
141752
|
+
"immutable": true,
|
|
141753
|
+
"locationInModule": {
|
|
141754
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141755
|
+
"line": 46
|
|
141756
|
+
},
|
|
141757
|
+
"name": "enabled",
|
|
141758
|
+
"optional": true,
|
|
141759
|
+
"type": {
|
|
141760
|
+
"primitive": "boolean"
|
|
141761
|
+
}
|
|
141762
|
+
},
|
|
141763
|
+
{
|
|
141764
|
+
"abstract": true,
|
|
141765
|
+
"docs": {
|
|
141766
|
+
"default": "- generated from the `id`",
|
|
141767
|
+
"remarks": "Notification rule names must be unique in your AWS account.",
|
|
141768
|
+
"stability": "stable",
|
|
141769
|
+
"summary": "The name for the notification rule."
|
|
141770
|
+
},
|
|
141771
|
+
"immutable": true,
|
|
141772
|
+
"locationInModule": {
|
|
141773
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141774
|
+
"line": 38
|
|
141775
|
+
},
|
|
141776
|
+
"name": "notificationRuleName",
|
|
141777
|
+
"optional": true,
|
|
141778
|
+
"type": {
|
|
141779
|
+
"primitive": "string"
|
|
141780
|
+
}
|
|
141781
|
+
}
|
|
141782
|
+
],
|
|
141783
|
+
"symbolId": "src/aws/notify/notification-rule:NotificationRuleOptions"
|
|
141784
|
+
},
|
|
141785
|
+
"terraconstructs.aws.notify.NotificationRuleProps": {
|
|
141786
|
+
"assembly": "terraconstructs",
|
|
141787
|
+
"datatype": true,
|
|
141788
|
+
"docs": {
|
|
141789
|
+
"stability": "stable",
|
|
141790
|
+
"summary": "Properties for a new notification rule."
|
|
141791
|
+
},
|
|
141792
|
+
"fqn": "terraconstructs.aws.notify.NotificationRuleProps",
|
|
141793
|
+
"interfaces": [
|
|
141794
|
+
"terraconstructs.aws.AwsConstructProps",
|
|
141795
|
+
"terraconstructs.aws.notify.NotificationRuleOptions"
|
|
141796
|
+
],
|
|
141797
|
+
"kind": "interface",
|
|
141798
|
+
"locationInModule": {
|
|
141799
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141800
|
+
"line": 70
|
|
141801
|
+
},
|
|
141802
|
+
"name": "NotificationRuleProps",
|
|
141803
|
+
"namespace": "aws.notify",
|
|
141804
|
+
"properties": [
|
|
141805
|
+
{
|
|
141806
|
+
"abstract": true,
|
|
141807
|
+
"docs": {
|
|
141808
|
+
"remarks": "For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.",
|
|
141809
|
+
"see": "https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api",
|
|
141810
|
+
"stability": "stable",
|
|
141811
|
+
"summary": "A list of event types associated with this notification rule."
|
|
141812
|
+
},
|
|
141813
|
+
"immutable": true,
|
|
141814
|
+
"locationInModule": {
|
|
141815
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141816
|
+
"line": 78
|
|
141817
|
+
},
|
|
141818
|
+
"name": "events",
|
|
141819
|
+
"type": {
|
|
141820
|
+
"collection": {
|
|
141821
|
+
"elementtype": {
|
|
141822
|
+
"primitive": "string"
|
|
141823
|
+
},
|
|
141824
|
+
"kind": "array"
|
|
141825
|
+
}
|
|
141826
|
+
}
|
|
141827
|
+
},
|
|
141828
|
+
{
|
|
141829
|
+
"abstract": true,
|
|
141830
|
+
"docs": {
|
|
141831
|
+
"remarks": "Currently, Supported sources include pipelines in AWS CodePipeline, build projects in AWS CodeBuild, and repositories in AWS CodeCommit in this L2 constructor.",
|
|
141832
|
+
"see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-resource",
|
|
141833
|
+
"stability": "stable",
|
|
141834
|
+
"summary": "The Amazon Resource Name (ARN) of the resource to associate with the notification rule."
|
|
141835
|
+
},
|
|
141836
|
+
"immutable": true,
|
|
141837
|
+
"locationInModule": {
|
|
141838
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141839
|
+
"line": 85
|
|
141840
|
+
},
|
|
141841
|
+
"name": "source",
|
|
141842
|
+
"type": {
|
|
141843
|
+
"fqn": "terraconstructs.aws.notify.INotificationRuleSource"
|
|
141844
|
+
}
|
|
141845
|
+
},
|
|
141846
|
+
{
|
|
141847
|
+
"abstract": true,
|
|
141848
|
+
"docs": {
|
|
141849
|
+
"stability": "stable",
|
|
141850
|
+
"summary": "Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.88.0/docs/resources/codestarnotifications_notification_rule#tags CodestarnotificationsNotificationRule#tags}."
|
|
141851
|
+
},
|
|
141852
|
+
"immutable": true,
|
|
141853
|
+
"locationInModule": {
|
|
141854
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141855
|
+
"line": 96
|
|
141856
|
+
},
|
|
141857
|
+
"name": "tags",
|
|
141858
|
+
"optional": true,
|
|
141859
|
+
"type": {
|
|
141860
|
+
"collection": {
|
|
141861
|
+
"elementtype": {
|
|
141862
|
+
"primitive": "string"
|
|
141863
|
+
},
|
|
141864
|
+
"kind": "map"
|
|
141865
|
+
}
|
|
141866
|
+
}
|
|
141867
|
+
},
|
|
141868
|
+
{
|
|
141869
|
+
"abstract": true,
|
|
141870
|
+
"docs": {
|
|
141871
|
+
"default": "- No targets are added to the rule. Use `addTarget()` to add a target.",
|
|
141872
|
+
"stability": "stable",
|
|
141873
|
+
"summary": "The targets to register for the notification destination."
|
|
141874
|
+
},
|
|
141875
|
+
"immutable": true,
|
|
141876
|
+
"locationInModule": {
|
|
141877
|
+
"filename": "src/aws/notify/notification-rule.ts",
|
|
141878
|
+
"line": 92
|
|
141879
|
+
},
|
|
141880
|
+
"name": "targets",
|
|
141881
|
+
"optional": true,
|
|
141882
|
+
"type": {
|
|
141883
|
+
"collection": {
|
|
141884
|
+
"elementtype": {
|
|
141885
|
+
"fqn": "terraconstructs.aws.notify.INotificationRuleTarget"
|
|
141886
|
+
},
|
|
141887
|
+
"kind": "array"
|
|
141888
|
+
}
|
|
141889
|
+
}
|
|
141890
|
+
}
|
|
141891
|
+
],
|
|
141892
|
+
"symbolId": "src/aws/notify/notification-rule:NotificationRuleProps"
|
|
141893
|
+
},
|
|
141894
|
+
"terraconstructs.aws.notify.NotificationRuleSourceConfig": {
|
|
141895
|
+
"assembly": "terraconstructs",
|
|
141896
|
+
"datatype": true,
|
|
141897
|
+
"docs": {
|
|
141898
|
+
"stability": "stable",
|
|
141899
|
+
"summary": "Information about the Codebuild or CodePipeline associated with a notification source."
|
|
141900
|
+
},
|
|
141901
|
+
"fqn": "terraconstructs.aws.notify.NotificationRuleSourceConfig",
|
|
141902
|
+
"kind": "interface",
|
|
141903
|
+
"locationInModule": {
|
|
141904
|
+
"filename": "src/aws/notify/notification-rule-source.ts",
|
|
141905
|
+
"line": 8
|
|
141906
|
+
},
|
|
141907
|
+
"name": "NotificationRuleSourceConfig",
|
|
141908
|
+
"namespace": "aws.notify",
|
|
141909
|
+
"properties": [
|
|
141910
|
+
{
|
|
141911
|
+
"abstract": true,
|
|
141912
|
+
"docs": {
|
|
141913
|
+
"stability": "stable",
|
|
141914
|
+
"summary": "The Amazon Resource Name (ARN) of the notification source."
|
|
141915
|
+
},
|
|
141916
|
+
"immutable": true,
|
|
141917
|
+
"locationInModule": {
|
|
141918
|
+
"filename": "src/aws/notify/notification-rule-source.ts",
|
|
141919
|
+
"line": 12
|
|
141920
|
+
},
|
|
141921
|
+
"name": "sourceArn",
|
|
141922
|
+
"type": {
|
|
141923
|
+
"primitive": "string"
|
|
141924
|
+
}
|
|
141925
|
+
}
|
|
141926
|
+
],
|
|
141927
|
+
"symbolId": "src/aws/notify/notification-rule-source:NotificationRuleSourceConfig"
|
|
141928
|
+
},
|
|
141929
|
+
"terraconstructs.aws.notify.NotificationRuleTargetConfig": {
|
|
141930
|
+
"assembly": "terraconstructs",
|
|
141931
|
+
"datatype": true,
|
|
141932
|
+
"docs": {
|
|
141933
|
+
"stability": "stable",
|
|
141934
|
+
"summary": "Information about the SNS topic or AWS Chatbot client associated with a notification target."
|
|
141935
|
+
},
|
|
141936
|
+
"fqn": "terraconstructs.aws.notify.NotificationRuleTargetConfig",
|
|
141937
|
+
"kind": "interface",
|
|
141938
|
+
"locationInModule": {
|
|
141939
|
+
"filename": "src/aws/notify/notification-rule-target.ts",
|
|
141940
|
+
"line": 8
|
|
141941
|
+
},
|
|
141942
|
+
"name": "NotificationRuleTargetConfig",
|
|
141943
|
+
"namespace": "aws.notify",
|
|
141944
|
+
"properties": [
|
|
141945
|
+
{
|
|
141946
|
+
"abstract": true,
|
|
141947
|
+
"docs": {
|
|
141948
|
+
"stability": "stable",
|
|
141949
|
+
"summary": "The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client."
|
|
141950
|
+
},
|
|
141951
|
+
"immutable": true,
|
|
141952
|
+
"locationInModule": {
|
|
141953
|
+
"filename": "src/aws/notify/notification-rule-target.ts",
|
|
141954
|
+
"line": 17
|
|
141955
|
+
},
|
|
141956
|
+
"name": "targetAddress",
|
|
141957
|
+
"type": {
|
|
141958
|
+
"primitive": "string"
|
|
141959
|
+
}
|
|
141960
|
+
},
|
|
141961
|
+
{
|
|
141962
|
+
"abstract": true,
|
|
141963
|
+
"docs": {
|
|
141964
|
+
"remarks": "Can be an Amazon SNS topic or AWS Chatbot client.",
|
|
141965
|
+
"stability": "stable",
|
|
141966
|
+
"summary": "The target type."
|
|
141967
|
+
},
|
|
141968
|
+
"immutable": true,
|
|
141969
|
+
"locationInModule": {
|
|
141970
|
+
"filename": "src/aws/notify/notification-rule-target.ts",
|
|
141971
|
+
"line": 12
|
|
141972
|
+
},
|
|
141973
|
+
"name": "targetType",
|
|
141974
|
+
"type": {
|
|
141975
|
+
"primitive": "string"
|
|
141976
|
+
}
|
|
141977
|
+
}
|
|
141978
|
+
],
|
|
141979
|
+
"symbolId": "src/aws/notify/notification-rule-target:NotificationRuleTargetConfig"
|
|
141980
|
+
},
|
|
141981
|
+
"terraconstructs.aws.notify.NumericConditions": {
|
|
141982
|
+
"assembly": "terraconstructs",
|
|
141983
|
+
"datatype": true,
|
|
141984
|
+
"docs": {
|
|
141985
|
+
"stability": "stable",
|
|
141986
|
+
"summary": "Conditions that can be applied to numeric attributes."
|
|
141987
|
+
},
|
|
141988
|
+
"fqn": "terraconstructs.aws.notify.NumericConditions",
|
|
141989
|
+
"kind": "interface",
|
|
141990
|
+
"locationInModule": {
|
|
141991
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
141992
|
+
"line": 72
|
|
141993
|
+
},
|
|
141994
|
+
"name": "NumericConditions",
|
|
141995
|
+
"namespace": "aws.notify",
|
|
141996
|
+
"properties": [
|
|
141997
|
+
{
|
|
141998
|
+
"abstract": true,
|
|
141999
|
+
"docs": {
|
|
142000
|
+
"default": "- None",
|
|
142001
|
+
"stability": "stable",
|
|
142002
|
+
"summary": "Match one or more values."
|
|
142003
|
+
},
|
|
142004
|
+
"immutable": true,
|
|
142005
|
+
"locationInModule": {
|
|
142006
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
142007
|
+
"line": 85
|
|
142008
|
+
},
|
|
142009
|
+
"name": "allowlist",
|
|
142010
|
+
"optional": true,
|
|
142011
|
+
"type": {
|
|
142012
|
+
"collection": {
|
|
142013
|
+
"elementtype": {
|
|
142014
|
+
"primitive": "number"
|
|
142015
|
+
},
|
|
142016
|
+
"kind": "array"
|
|
142017
|
+
}
|
|
142018
|
+
}
|
|
142019
|
+
},
|
|
142020
|
+
{
|
|
142021
|
+
"abstract": true,
|
|
142022
|
+
"docs": {
|
|
142023
|
+
"default": "- None",
|
|
142024
|
+
"stability": "stable",
|
|
142025
|
+
"summary": "Match values that are between the specified values."
|
|
142026
|
+
},
|
|
142027
|
+
"immutable": true,
|
|
142028
|
+
"locationInModule": {
|
|
142029
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
142030
|
+
"line": 120
|
|
142031
|
+
},
|
|
142032
|
+
"name": "between",
|
|
142033
|
+
"optional": true,
|
|
142034
|
+
"type": {
|
|
142035
|
+
"fqn": "terraconstructs.aws.notify.BetweenCondition"
|
|
142036
|
+
}
|
|
142037
|
+
},
|
|
142038
|
+
{
|
|
142039
|
+
"abstract": true,
|
|
142040
|
+
"docs": {
|
|
142041
|
+
"default": "- None",
|
|
142042
|
+
"stability": "stable",
|
|
142043
|
+
"summary": "Match values that are strictly between the specified values."
|
|
142044
|
+
},
|
|
142045
|
+
"immutable": true,
|
|
142046
|
+
"locationInModule": {
|
|
142047
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
142048
|
+
"line": 127
|
|
142049
|
+
},
|
|
142050
|
+
"name": "betweenStrict",
|
|
142051
|
+
"optional": true,
|
|
142052
|
+
"type": {
|
|
142053
|
+
"fqn": "terraconstructs.aws.notify.BetweenCondition"
|
|
142054
|
+
}
|
|
142055
|
+
},
|
|
142056
|
+
{
|
|
142057
|
+
"abstract": true,
|
|
142058
|
+
"docs": {
|
|
142059
|
+
"default": "- None",
|
|
142060
|
+
"stability": "stable",
|
|
142061
|
+
"summary": "Match values that are greater than the specified value."
|
|
142062
|
+
},
|
|
142063
|
+
"immutable": true,
|
|
142064
|
+
"locationInModule": {
|
|
142065
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
142066
|
+
"line": 92
|
|
142067
|
+
},
|
|
142068
|
+
"name": "greaterThan",
|
|
142069
|
+
"optional": true,
|
|
142070
|
+
"type": {
|
|
142071
|
+
"primitive": "number"
|
|
142072
|
+
}
|
|
142073
|
+
},
|
|
142074
|
+
{
|
|
142075
|
+
"abstract": true,
|
|
142076
|
+
"docs": {
|
|
142077
|
+
"default": "- None",
|
|
142078
|
+
"stability": "stable",
|
|
142079
|
+
"summary": "Match values that are greater than or equal to the specified value."
|
|
142080
|
+
},
|
|
142081
|
+
"immutable": true,
|
|
142082
|
+
"locationInModule": {
|
|
142083
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
142084
|
+
"line": 99
|
|
142085
|
+
},
|
|
142086
|
+
"name": "greaterThanOrEqualTo",
|
|
142087
|
+
"optional": true,
|
|
142088
|
+
"type": {
|
|
142089
|
+
"primitive": "number"
|
|
142090
|
+
}
|
|
142091
|
+
},
|
|
142092
|
+
{
|
|
142093
|
+
"abstract": true,
|
|
142094
|
+
"docs": {
|
|
142095
|
+
"default": "- None",
|
|
142096
|
+
"stability": "stable",
|
|
142097
|
+
"summary": "Match values that are less than the specified value."
|
|
142098
|
+
},
|
|
142099
|
+
"immutable": true,
|
|
142100
|
+
"locationInModule": {
|
|
142101
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
142102
|
+
"line": 106
|
|
142103
|
+
},
|
|
142104
|
+
"name": "lessThan",
|
|
142105
|
+
"optional": true,
|
|
142106
|
+
"type": {
|
|
142107
|
+
"primitive": "number"
|
|
142108
|
+
}
|
|
142109
|
+
},
|
|
142110
|
+
{
|
|
142111
|
+
"abstract": true,
|
|
142112
|
+
"docs": {
|
|
142113
|
+
"default": "- None",
|
|
142114
|
+
"stability": "stable",
|
|
142115
|
+
"summary": "Match values that are less than or equal to the specified value."
|
|
142116
|
+
},
|
|
142117
|
+
"immutable": true,
|
|
142118
|
+
"locationInModule": {
|
|
142119
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
142120
|
+
"line": 113
|
|
142121
|
+
},
|
|
142122
|
+
"name": "lessThanOrEqualTo",
|
|
142123
|
+
"optional": true,
|
|
142124
|
+
"type": {
|
|
142125
|
+
"primitive": "number"
|
|
142126
|
+
}
|
|
142127
|
+
},
|
|
142128
|
+
{
|
|
142129
|
+
"abstract": true,
|
|
142130
|
+
"docs": {
|
|
142131
|
+
"default": "- None",
|
|
142132
|
+
"deprecated": "use `allowlist`",
|
|
142133
|
+
"stability": "deprecated",
|
|
142134
|
+
"summary": "Match one or more values."
|
|
142135
|
+
},
|
|
142136
|
+
"immutable": true,
|
|
142137
|
+
"locationInModule": {
|
|
142138
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
142139
|
+
"line": 78
|
|
142140
|
+
},
|
|
142141
|
+
"name": "whitelist",
|
|
142142
|
+
"optional": true,
|
|
142143
|
+
"type": {
|
|
142144
|
+
"collection": {
|
|
142145
|
+
"elementtype": {
|
|
142146
|
+
"primitive": "number"
|
|
142147
|
+
},
|
|
142148
|
+
"kind": "array"
|
|
142149
|
+
}
|
|
142150
|
+
}
|
|
142151
|
+
}
|
|
142152
|
+
],
|
|
142153
|
+
"symbolId": "src/aws/notify/subscription-filter:NumericConditions"
|
|
142154
|
+
},
|
|
140097
142155
|
"terraconstructs.aws.notify.OAuthAuthorizationProps": {
|
|
140098
142156
|
"assembly": "terraconstructs",
|
|
140099
142157
|
"datatype": true,
|
|
@@ -140287,6 +142345,87 @@
|
|
|
140287
142345
|
],
|
|
140288
142346
|
"symbolId": "src/aws/notify/on-event-options:OnEventOptions"
|
|
140289
142347
|
},
|
|
142348
|
+
"terraconstructs.aws.notify.Policy": {
|
|
142349
|
+
"assembly": "terraconstructs",
|
|
142350
|
+
"base": "terraconstructs.aws.notify.FilterOrPolicy",
|
|
142351
|
+
"docs": {
|
|
142352
|
+
"stability": "stable",
|
|
142353
|
+
"summary": "Policy Implementation of FilterOrPolicy."
|
|
142354
|
+
},
|
|
142355
|
+
"fqn": "terraconstructs.aws.notify.Policy",
|
|
142356
|
+
"initializer": {
|
|
142357
|
+
"docs": {
|
|
142358
|
+
"stability": "stable",
|
|
142359
|
+
"summary": "Policy constructor."
|
|
142360
|
+
},
|
|
142361
|
+
"locationInModule": {
|
|
142362
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
142363
|
+
"line": 577
|
|
142364
|
+
},
|
|
142365
|
+
"parameters": [
|
|
142366
|
+
{
|
|
142367
|
+
"docs": {
|
|
142368
|
+
"summary": "policy argument to construct."
|
|
142369
|
+
},
|
|
142370
|
+
"name": "policyDoc",
|
|
142371
|
+
"type": {
|
|
142372
|
+
"collection": {
|
|
142373
|
+
"elementtype": {
|
|
142374
|
+
"fqn": "terraconstructs.aws.notify.FilterOrPolicy"
|
|
142375
|
+
},
|
|
142376
|
+
"kind": "map"
|
|
142377
|
+
}
|
|
142378
|
+
}
|
|
142379
|
+
}
|
|
142380
|
+
]
|
|
142381
|
+
},
|
|
142382
|
+
"kind": "class",
|
|
142383
|
+
"locationInModule": {
|
|
142384
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
142385
|
+
"line": 568
|
|
142386
|
+
},
|
|
142387
|
+
"name": "Policy",
|
|
142388
|
+
"namespace": "aws.notify",
|
|
142389
|
+
"properties": [
|
|
142390
|
+
{
|
|
142391
|
+
"docs": {
|
|
142392
|
+
"stability": "stable",
|
|
142393
|
+
"summary": "policy argument to construct."
|
|
142394
|
+
},
|
|
142395
|
+
"immutable": true,
|
|
142396
|
+
"locationInModule": {
|
|
142397
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
142398
|
+
"line": 578
|
|
142399
|
+
},
|
|
142400
|
+
"name": "policyDoc",
|
|
142401
|
+
"type": {
|
|
142402
|
+
"collection": {
|
|
142403
|
+
"elementtype": {
|
|
142404
|
+
"fqn": "terraconstructs.aws.notify.FilterOrPolicy"
|
|
142405
|
+
},
|
|
142406
|
+
"kind": "map"
|
|
142407
|
+
}
|
|
142408
|
+
}
|
|
142409
|
+
},
|
|
142410
|
+
{
|
|
142411
|
+
"docs": {
|
|
142412
|
+
"stability": "stable",
|
|
142413
|
+
"summary": "Type used in DFS buildFilterPolicyWithMessageBody to determine json value type."
|
|
142414
|
+
},
|
|
142415
|
+
"immutable": true,
|
|
142416
|
+
"locationInModule": {
|
|
142417
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
142418
|
+
"line": 572
|
|
142419
|
+
},
|
|
142420
|
+
"name": "type",
|
|
142421
|
+
"overrides": "terraconstructs.aws.notify.FilterOrPolicy",
|
|
142422
|
+
"type": {
|
|
142423
|
+
"fqn": "terraconstructs.aws.notify.FilterOrPolicyType"
|
|
142424
|
+
}
|
|
142425
|
+
}
|
|
142426
|
+
],
|
|
142427
|
+
"symbolId": "src/aws/notify/subscription:Policy"
|
|
142428
|
+
},
|
|
140290
142429
|
"terraconstructs.aws.notify.Queue": {
|
|
140291
142430
|
"assembly": "terraconstructs",
|
|
140292
142431
|
"base": "terraconstructs.aws.AwsConstructBase",
|
|
@@ -141349,6 +143488,43 @@
|
|
|
141349
143488
|
"namespace": "aws.notify",
|
|
141350
143489
|
"symbolId": "src/aws/notify/queue:RedrivePermission"
|
|
141351
143490
|
},
|
|
143491
|
+
"terraconstructs.aws.notify.RequestPolicy": {
|
|
143492
|
+
"assembly": "terraconstructs",
|
|
143493
|
+
"datatype": true,
|
|
143494
|
+
"docs": {
|
|
143495
|
+
"stability": "stable",
|
|
143496
|
+
"summary": "Options for customising aspects of the content sent in AWS SNS HTTP/S requests."
|
|
143497
|
+
},
|
|
143498
|
+
"fqn": "terraconstructs.aws.notify.RequestPolicy",
|
|
143499
|
+
"kind": "interface",
|
|
143500
|
+
"locationInModule": {
|
|
143501
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
143502
|
+
"line": 42
|
|
143503
|
+
},
|
|
143504
|
+
"name": "RequestPolicy",
|
|
143505
|
+
"namespace": "aws.notify",
|
|
143506
|
+
"properties": [
|
|
143507
|
+
{
|
|
143508
|
+
"abstract": true,
|
|
143509
|
+
"docs": {
|
|
143510
|
+
"default": "- text/plain; charset=UTF-8",
|
|
143511
|
+
"stability": "stable",
|
|
143512
|
+
"summary": "The content type of the notification being sent to HTTP/S endpoints."
|
|
143513
|
+
},
|
|
143514
|
+
"immutable": true,
|
|
143515
|
+
"locationInModule": {
|
|
143516
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
143517
|
+
"line": 48
|
|
143518
|
+
},
|
|
143519
|
+
"name": "headerContentType",
|
|
143520
|
+
"optional": true,
|
|
143521
|
+
"type": {
|
|
143522
|
+
"primitive": "string"
|
|
143523
|
+
}
|
|
143524
|
+
}
|
|
143525
|
+
],
|
|
143526
|
+
"symbolId": "src/aws/notify/delivery-policy:RequestPolicy"
|
|
143527
|
+
},
|
|
141352
143528
|
"terraconstructs.aws.notify.ResourcePolicy": {
|
|
141353
143529
|
"assembly": "terraconstructs",
|
|
141354
143530
|
"base": "terraconstructs.aws.AwsConstructBase",
|
|
@@ -144356,6 +146532,2360 @@
|
|
|
144356
146532
|
],
|
|
144357
146533
|
"symbolId": "src/aws/notify/kinesis-stream:StreamProps"
|
|
144358
146534
|
},
|
|
146535
|
+
"terraconstructs.aws.notify.StringConditions": {
|
|
146536
|
+
"assembly": "terraconstructs",
|
|
146537
|
+
"datatype": true,
|
|
146538
|
+
"docs": {
|
|
146539
|
+
"stability": "stable",
|
|
146540
|
+
"summary": "Conditions that can be applied to string attributes."
|
|
146541
|
+
},
|
|
146542
|
+
"fqn": "terraconstructs.aws.notify.StringConditions",
|
|
146543
|
+
"kind": "interface",
|
|
146544
|
+
"locationInModule": {
|
|
146545
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146546
|
+
"line": 11
|
|
146547
|
+
},
|
|
146548
|
+
"name": "StringConditions",
|
|
146549
|
+
"namespace": "aws.notify",
|
|
146550
|
+
"properties": [
|
|
146551
|
+
{
|
|
146552
|
+
"abstract": true,
|
|
146553
|
+
"docs": {
|
|
146554
|
+
"default": "- None",
|
|
146555
|
+
"stability": "stable",
|
|
146556
|
+
"summary": "Match one or more values."
|
|
146557
|
+
},
|
|
146558
|
+
"immutable": true,
|
|
146559
|
+
"locationInModule": {
|
|
146560
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146561
|
+
"line": 31
|
|
146562
|
+
},
|
|
146563
|
+
"name": "allowlist",
|
|
146564
|
+
"optional": true,
|
|
146565
|
+
"type": {
|
|
146566
|
+
"collection": {
|
|
146567
|
+
"elementtype": {
|
|
146568
|
+
"primitive": "string"
|
|
146569
|
+
},
|
|
146570
|
+
"kind": "array"
|
|
146571
|
+
}
|
|
146572
|
+
}
|
|
146573
|
+
},
|
|
146574
|
+
{
|
|
146575
|
+
"abstract": true,
|
|
146576
|
+
"docs": {
|
|
146577
|
+
"default": "- None",
|
|
146578
|
+
"deprecated": "use `denylist`",
|
|
146579
|
+
"stability": "deprecated",
|
|
146580
|
+
"summary": "Match any value that doesn't include any of the specified values."
|
|
146581
|
+
},
|
|
146582
|
+
"immutable": true,
|
|
146583
|
+
"locationInModule": {
|
|
146584
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146585
|
+
"line": 25
|
|
146586
|
+
},
|
|
146587
|
+
"name": "blacklist",
|
|
146588
|
+
"optional": true,
|
|
146589
|
+
"type": {
|
|
146590
|
+
"collection": {
|
|
146591
|
+
"elementtype": {
|
|
146592
|
+
"primitive": "string"
|
|
146593
|
+
},
|
|
146594
|
+
"kind": "array"
|
|
146595
|
+
}
|
|
146596
|
+
}
|
|
146597
|
+
},
|
|
146598
|
+
{
|
|
146599
|
+
"abstract": true,
|
|
146600
|
+
"docs": {
|
|
146601
|
+
"default": "- None",
|
|
146602
|
+
"stability": "stable",
|
|
146603
|
+
"summary": "Match any value that doesn't include any of the specified values."
|
|
146604
|
+
},
|
|
146605
|
+
"immutable": true,
|
|
146606
|
+
"locationInModule": {
|
|
146607
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146608
|
+
"line": 37
|
|
146609
|
+
},
|
|
146610
|
+
"name": "denylist",
|
|
146611
|
+
"optional": true,
|
|
146612
|
+
"type": {
|
|
146613
|
+
"collection": {
|
|
146614
|
+
"elementtype": {
|
|
146615
|
+
"primitive": "string"
|
|
146616
|
+
},
|
|
146617
|
+
"kind": "array"
|
|
146618
|
+
}
|
|
146619
|
+
}
|
|
146620
|
+
},
|
|
146621
|
+
{
|
|
146622
|
+
"abstract": true,
|
|
146623
|
+
"docs": {
|
|
146624
|
+
"default": "- None",
|
|
146625
|
+
"stability": "stable",
|
|
146626
|
+
"summary": "Matches values that begins with the specified prefixes."
|
|
146627
|
+
},
|
|
146628
|
+
"immutable": true,
|
|
146629
|
+
"locationInModule": {
|
|
146630
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146631
|
+
"line": 44
|
|
146632
|
+
},
|
|
146633
|
+
"name": "matchPrefixes",
|
|
146634
|
+
"optional": true,
|
|
146635
|
+
"type": {
|
|
146636
|
+
"collection": {
|
|
146637
|
+
"elementtype": {
|
|
146638
|
+
"primitive": "string"
|
|
146639
|
+
},
|
|
146640
|
+
"kind": "array"
|
|
146641
|
+
}
|
|
146642
|
+
}
|
|
146643
|
+
},
|
|
146644
|
+
{
|
|
146645
|
+
"abstract": true,
|
|
146646
|
+
"docs": {
|
|
146647
|
+
"default": "- None",
|
|
146648
|
+
"stability": "stable",
|
|
146649
|
+
"summary": "Matches values that end with the specified suffixes."
|
|
146650
|
+
},
|
|
146651
|
+
"immutable": true,
|
|
146652
|
+
"locationInModule": {
|
|
146653
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146654
|
+
"line": 51
|
|
146655
|
+
},
|
|
146656
|
+
"name": "matchSuffixes",
|
|
146657
|
+
"optional": true,
|
|
146658
|
+
"type": {
|
|
146659
|
+
"collection": {
|
|
146660
|
+
"elementtype": {
|
|
146661
|
+
"primitive": "string"
|
|
146662
|
+
},
|
|
146663
|
+
"kind": "array"
|
|
146664
|
+
}
|
|
146665
|
+
}
|
|
146666
|
+
},
|
|
146667
|
+
{
|
|
146668
|
+
"abstract": true,
|
|
146669
|
+
"docs": {
|
|
146670
|
+
"default": "- None",
|
|
146671
|
+
"deprecated": "use `allowlist`",
|
|
146672
|
+
"stability": "deprecated",
|
|
146673
|
+
"summary": "Match one or more values."
|
|
146674
|
+
},
|
|
146675
|
+
"immutable": true,
|
|
146676
|
+
"locationInModule": {
|
|
146677
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146678
|
+
"line": 18
|
|
146679
|
+
},
|
|
146680
|
+
"name": "whitelist",
|
|
146681
|
+
"optional": true,
|
|
146682
|
+
"type": {
|
|
146683
|
+
"collection": {
|
|
146684
|
+
"elementtype": {
|
|
146685
|
+
"primitive": "string"
|
|
146686
|
+
},
|
|
146687
|
+
"kind": "array"
|
|
146688
|
+
}
|
|
146689
|
+
}
|
|
146690
|
+
}
|
|
146691
|
+
],
|
|
146692
|
+
"symbolId": "src/aws/notify/subscription-filter:StringConditions"
|
|
146693
|
+
},
|
|
146694
|
+
"terraconstructs.aws.notify.Subscription": {
|
|
146695
|
+
"assembly": "terraconstructs",
|
|
146696
|
+
"base": "terraconstructs.aws.AwsConstructBase",
|
|
146697
|
+
"docs": {
|
|
146698
|
+
"custom": {
|
|
146699
|
+
"resource": "aws_sns_topic_subscription"
|
|
146700
|
+
},
|
|
146701
|
+
"remarks": "Prefer to use the `ITopic.addSubscription()` methods to create instances of\nthis class.",
|
|
146702
|
+
"stability": "stable",
|
|
146703
|
+
"summary": "A new subscription."
|
|
146704
|
+
},
|
|
146705
|
+
"fqn": "terraconstructs.aws.notify.Subscription",
|
|
146706
|
+
"initializer": {
|
|
146707
|
+
"docs": {
|
|
146708
|
+
"stability": "stable"
|
|
146709
|
+
},
|
|
146710
|
+
"locationInModule": {
|
|
146711
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
146712
|
+
"line": 126
|
|
146713
|
+
},
|
|
146714
|
+
"parameters": [
|
|
146715
|
+
{
|
|
146716
|
+
"name": "scope",
|
|
146717
|
+
"type": {
|
|
146718
|
+
"fqn": "constructs.Construct"
|
|
146719
|
+
}
|
|
146720
|
+
},
|
|
146721
|
+
{
|
|
146722
|
+
"name": "id",
|
|
146723
|
+
"type": {
|
|
146724
|
+
"primitive": "string"
|
|
146725
|
+
}
|
|
146726
|
+
},
|
|
146727
|
+
{
|
|
146728
|
+
"name": "props",
|
|
146729
|
+
"type": {
|
|
146730
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionProps"
|
|
146731
|
+
}
|
|
146732
|
+
}
|
|
146733
|
+
]
|
|
146734
|
+
},
|
|
146735
|
+
"kind": "class",
|
|
146736
|
+
"locationInModule": {
|
|
146737
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
146738
|
+
"line": 113
|
|
146739
|
+
},
|
|
146740
|
+
"name": "Subscription",
|
|
146741
|
+
"namespace": "aws.notify",
|
|
146742
|
+
"properties": [
|
|
146743
|
+
{
|
|
146744
|
+
"docs": {
|
|
146745
|
+
"stability": "stable",
|
|
146746
|
+
"summary": "Outputs to register with the parent Scope or undefined if there are no outputs."
|
|
146747
|
+
},
|
|
146748
|
+
"immutable": true,
|
|
146749
|
+
"locationInModule": {
|
|
146750
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
146751
|
+
"line": 122
|
|
146752
|
+
},
|
|
146753
|
+
"name": "outputs",
|
|
146754
|
+
"overrides": "terraconstructs.TerraConstructBase",
|
|
146755
|
+
"type": {
|
|
146756
|
+
"collection": {
|
|
146757
|
+
"elementtype": {
|
|
146758
|
+
"primitive": "any"
|
|
146759
|
+
},
|
|
146760
|
+
"kind": "map"
|
|
146761
|
+
}
|
|
146762
|
+
}
|
|
146763
|
+
},
|
|
146764
|
+
{
|
|
146765
|
+
"docs": {
|
|
146766
|
+
"stability": "stable"
|
|
146767
|
+
},
|
|
146768
|
+
"immutable": true,
|
|
146769
|
+
"locationInModule": {
|
|
146770
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
146771
|
+
"line": 121
|
|
146772
|
+
},
|
|
146773
|
+
"name": "subscriptionOutputs",
|
|
146774
|
+
"type": {
|
|
146775
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionOutputs"
|
|
146776
|
+
}
|
|
146777
|
+
},
|
|
146778
|
+
{
|
|
146779
|
+
"docs": {
|
|
146780
|
+
"stability": "stable",
|
|
146781
|
+
"summary": "The DLQ associated with this subscription if present."
|
|
146782
|
+
},
|
|
146783
|
+
"immutable": true,
|
|
146784
|
+
"locationInModule": {
|
|
146785
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
146786
|
+
"line": 117
|
|
146787
|
+
},
|
|
146788
|
+
"name": "deadLetterQueue",
|
|
146789
|
+
"optional": true,
|
|
146790
|
+
"type": {
|
|
146791
|
+
"fqn": "terraconstructs.aws.notify.IQueue"
|
|
146792
|
+
}
|
|
146793
|
+
}
|
|
146794
|
+
],
|
|
146795
|
+
"symbolId": "src/aws/notify/subscription:Subscription"
|
|
146796
|
+
},
|
|
146797
|
+
"terraconstructs.aws.notify.SubscriptionFilter": {
|
|
146798
|
+
"assembly": "terraconstructs",
|
|
146799
|
+
"docs": {
|
|
146800
|
+
"stability": "stable",
|
|
146801
|
+
"summary": "A subscription filter for an attribute."
|
|
146802
|
+
},
|
|
146803
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionFilter",
|
|
146804
|
+
"initializer": {
|
|
146805
|
+
"docs": {
|
|
146806
|
+
"stability": "stable"
|
|
146807
|
+
},
|
|
146808
|
+
"locationInModule": {
|
|
146809
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146810
|
+
"line": 251
|
|
146811
|
+
},
|
|
146812
|
+
"parameters": [
|
|
146813
|
+
{
|
|
146814
|
+
"docs": {
|
|
146815
|
+
"summary": "conditions that specify the message attributes that should be included, excluded, matched, etc."
|
|
146816
|
+
},
|
|
146817
|
+
"name": "conditions",
|
|
146818
|
+
"optional": true,
|
|
146819
|
+
"type": {
|
|
146820
|
+
"collection": {
|
|
146821
|
+
"elementtype": {
|
|
146822
|
+
"primitive": "any"
|
|
146823
|
+
},
|
|
146824
|
+
"kind": "array"
|
|
146825
|
+
}
|
|
146826
|
+
}
|
|
146827
|
+
}
|
|
146828
|
+
]
|
|
146829
|
+
},
|
|
146830
|
+
"kind": "class",
|
|
146831
|
+
"locationInModule": {
|
|
146832
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146833
|
+
"line": 133
|
|
146834
|
+
},
|
|
146835
|
+
"methods": [
|
|
146836
|
+
{
|
|
146837
|
+
"docs": {
|
|
146838
|
+
"stability": "stable",
|
|
146839
|
+
"summary": "Returns a subscription filter for attribute key matching."
|
|
146840
|
+
},
|
|
146841
|
+
"locationInModule": {
|
|
146842
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146843
|
+
"line": 243
|
|
146844
|
+
},
|
|
146845
|
+
"name": "existsFilter",
|
|
146846
|
+
"returns": {
|
|
146847
|
+
"type": {
|
|
146848
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionFilter"
|
|
146849
|
+
}
|
|
146850
|
+
},
|
|
146851
|
+
"static": true
|
|
146852
|
+
},
|
|
146853
|
+
{
|
|
146854
|
+
"docs": {
|
|
146855
|
+
"stability": "stable",
|
|
146856
|
+
"summary": "Returns a subscription filter for a numeric attribute."
|
|
146857
|
+
},
|
|
146858
|
+
"locationInModule": {
|
|
146859
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146860
|
+
"line": 181
|
|
146861
|
+
},
|
|
146862
|
+
"name": "numericFilter",
|
|
146863
|
+
"parameters": [
|
|
146864
|
+
{
|
|
146865
|
+
"name": "numericConditions",
|
|
146866
|
+
"type": {
|
|
146867
|
+
"fqn": "terraconstructs.aws.notify.NumericConditions"
|
|
146868
|
+
}
|
|
146869
|
+
}
|
|
146870
|
+
],
|
|
146871
|
+
"returns": {
|
|
146872
|
+
"type": {
|
|
146873
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionFilter"
|
|
146874
|
+
}
|
|
146875
|
+
},
|
|
146876
|
+
"static": true
|
|
146877
|
+
},
|
|
146878
|
+
{
|
|
146879
|
+
"docs": {
|
|
146880
|
+
"stability": "stable",
|
|
146881
|
+
"summary": "Returns a subscription filter for a string attribute."
|
|
146882
|
+
},
|
|
146883
|
+
"locationInModule": {
|
|
146884
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146885
|
+
"line": 137
|
|
146886
|
+
},
|
|
146887
|
+
"name": "stringFilter",
|
|
146888
|
+
"parameters": [
|
|
146889
|
+
{
|
|
146890
|
+
"name": "stringConditions",
|
|
146891
|
+
"type": {
|
|
146892
|
+
"fqn": "terraconstructs.aws.notify.StringConditions"
|
|
146893
|
+
}
|
|
146894
|
+
}
|
|
146895
|
+
],
|
|
146896
|
+
"returns": {
|
|
146897
|
+
"type": {
|
|
146898
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionFilter"
|
|
146899
|
+
}
|
|
146900
|
+
},
|
|
146901
|
+
"static": true
|
|
146902
|
+
}
|
|
146903
|
+
],
|
|
146904
|
+
"name": "SubscriptionFilter",
|
|
146905
|
+
"namespace": "aws.notify",
|
|
146906
|
+
"properties": [
|
|
146907
|
+
{
|
|
146908
|
+
"docs": {
|
|
146909
|
+
"stability": "stable",
|
|
146910
|
+
"summary": "conditions that specify the message attributes that should be included, excluded, matched, etc."
|
|
146911
|
+
},
|
|
146912
|
+
"immutable": true,
|
|
146913
|
+
"locationInModule": {
|
|
146914
|
+
"filename": "src/aws/notify/subscription-filter.ts",
|
|
146915
|
+
"line": 251
|
|
146916
|
+
},
|
|
146917
|
+
"name": "conditions",
|
|
146918
|
+
"type": {
|
|
146919
|
+
"collection": {
|
|
146920
|
+
"elementtype": {
|
|
146921
|
+
"primitive": "any"
|
|
146922
|
+
},
|
|
146923
|
+
"kind": "array"
|
|
146924
|
+
}
|
|
146925
|
+
}
|
|
146926
|
+
}
|
|
146927
|
+
],
|
|
146928
|
+
"symbolId": "src/aws/notify/subscription-filter:SubscriptionFilter"
|
|
146929
|
+
},
|
|
146930
|
+
"terraconstructs.aws.notify.SubscriptionOptions": {
|
|
146931
|
+
"assembly": "terraconstructs",
|
|
146932
|
+
"datatype": true,
|
|
146933
|
+
"docs": {
|
|
146934
|
+
"stability": "stable",
|
|
146935
|
+
"summary": "Options for creating a new subscription."
|
|
146936
|
+
},
|
|
146937
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionOptions",
|
|
146938
|
+
"interfaces": [
|
|
146939
|
+
"terraconstructs.aws.AwsConstructProps"
|
|
146940
|
+
],
|
|
146941
|
+
"kind": "interface",
|
|
146942
|
+
"locationInModule": {
|
|
146943
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
146944
|
+
"line": 25
|
|
146945
|
+
},
|
|
146946
|
+
"name": "SubscriptionOptions",
|
|
146947
|
+
"namespace": "aws.notify",
|
|
146948
|
+
"properties": [
|
|
146949
|
+
{
|
|
146950
|
+
"abstract": true,
|
|
146951
|
+
"docs": {
|
|
146952
|
+
"remarks": "The meaning of this value depends on the value for 'protocol'.",
|
|
146953
|
+
"stability": "stable",
|
|
146954
|
+
"summary": "The subscription endpoint."
|
|
146955
|
+
},
|
|
146956
|
+
"immutable": true,
|
|
146957
|
+
"locationInModule": {
|
|
146958
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
146959
|
+
"line": 36
|
|
146960
|
+
},
|
|
146961
|
+
"name": "endpoint",
|
|
146962
|
+
"type": {
|
|
146963
|
+
"primitive": "string"
|
|
146964
|
+
}
|
|
146965
|
+
},
|
|
146966
|
+
{
|
|
146967
|
+
"abstract": true,
|
|
146968
|
+
"docs": {
|
|
146969
|
+
"stability": "stable",
|
|
146970
|
+
"summary": "What type of subscription to add."
|
|
146971
|
+
},
|
|
146972
|
+
"immutable": true,
|
|
146973
|
+
"locationInModule": {
|
|
146974
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
146975
|
+
"line": 29
|
|
146976
|
+
},
|
|
146977
|
+
"name": "protocol",
|
|
146978
|
+
"type": {
|
|
146979
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionProtocol"
|
|
146980
|
+
}
|
|
146981
|
+
},
|
|
146982
|
+
{
|
|
146983
|
+
"abstract": true,
|
|
146984
|
+
"docs": {
|
|
146985
|
+
"default": "- No dead letter queue enabled.",
|
|
146986
|
+
"remarks": "If not passed no dead letter queue is enabled.",
|
|
146987
|
+
"stability": "stable",
|
|
146988
|
+
"summary": "Queue to be used as dead letter queue."
|
|
146989
|
+
},
|
|
146990
|
+
"immutable": true,
|
|
146991
|
+
"locationInModule": {
|
|
146992
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
146993
|
+
"line": 79
|
|
146994
|
+
},
|
|
146995
|
+
"name": "deadLetterQueue",
|
|
146996
|
+
"optional": true,
|
|
146997
|
+
"type": {
|
|
146998
|
+
"fqn": "terraconstructs.aws.notify.IQueue"
|
|
146999
|
+
}
|
|
147000
|
+
},
|
|
147001
|
+
{
|
|
147002
|
+
"abstract": true,
|
|
147003
|
+
"docs": {
|
|
147004
|
+
"default": "- if the initial delivery of the message fails, three retries with a delay between failed attempts set at 20 seconds",
|
|
147005
|
+
"stability": "stable",
|
|
147006
|
+
"summary": "The delivery policy."
|
|
147007
|
+
},
|
|
147008
|
+
"immutable": true,
|
|
147009
|
+
"locationInModule": {
|
|
147010
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
147011
|
+
"line": 93
|
|
147012
|
+
},
|
|
147013
|
+
"name": "deliveryPolicy",
|
|
147014
|
+
"optional": true,
|
|
147015
|
+
"type": {
|
|
147016
|
+
"fqn": "terraconstructs.aws.notify.DeliveryPolicy"
|
|
147017
|
+
}
|
|
147018
|
+
},
|
|
147019
|
+
{
|
|
147020
|
+
"abstract": true,
|
|
147021
|
+
"docs": {
|
|
147022
|
+
"default": "- all messages are delivered",
|
|
147023
|
+
"stability": "stable",
|
|
147024
|
+
"summary": "The filter policy."
|
|
147025
|
+
},
|
|
147026
|
+
"immutable": true,
|
|
147027
|
+
"locationInModule": {
|
|
147028
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
147029
|
+
"line": 52
|
|
147030
|
+
},
|
|
147031
|
+
"name": "filterPolicy",
|
|
147032
|
+
"optional": true,
|
|
147033
|
+
"type": {
|
|
147034
|
+
"collection": {
|
|
147035
|
+
"elementtype": {
|
|
147036
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionFilter"
|
|
147037
|
+
},
|
|
147038
|
+
"kind": "map"
|
|
147039
|
+
}
|
|
147040
|
+
}
|
|
147041
|
+
},
|
|
147042
|
+
{
|
|
147043
|
+
"abstract": true,
|
|
147044
|
+
"docs": {
|
|
147045
|
+
"default": "- all messages are delivered",
|
|
147046
|
+
"remarks": "To apply a filter policy to the message attributes, use `filterPolicy`. A maximum of one of `filterPolicyWithMessageBody` and `filterPolicy` may be used.",
|
|
147047
|
+
"stability": "stable",
|
|
147048
|
+
"summary": "The filter policy that is applied on the message body."
|
|
147049
|
+
},
|
|
147050
|
+
"immutable": true,
|
|
147051
|
+
"locationInModule": {
|
|
147052
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
147053
|
+
"line": 60
|
|
147054
|
+
},
|
|
147055
|
+
"name": "filterPolicyWithMessageBody",
|
|
147056
|
+
"optional": true,
|
|
147057
|
+
"type": {
|
|
147058
|
+
"collection": {
|
|
147059
|
+
"elementtype": {
|
|
147060
|
+
"fqn": "terraconstructs.aws.notify.FilterOrPolicy"
|
|
147061
|
+
},
|
|
147062
|
+
"kind": "map"
|
|
147063
|
+
}
|
|
147064
|
+
}
|
|
147065
|
+
},
|
|
147066
|
+
{
|
|
147067
|
+
"abstract": true,
|
|
147068
|
+
"docs": {
|
|
147069
|
+
"default": "false",
|
|
147070
|
+
"remarks": "Raw messages are free of JSON formatting and can be\nsent to HTTP/S and Amazon SQS endpoints. For more information, see GetSubscriptionAttributes in the Amazon Simple\nNotification Service API Reference.",
|
|
147071
|
+
"stability": "stable",
|
|
147072
|
+
"summary": "true if raw message delivery is enabled for the subscription."
|
|
147073
|
+
},
|
|
147074
|
+
"immutable": true,
|
|
147075
|
+
"locationInModule": {
|
|
147076
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
147077
|
+
"line": 45
|
|
147078
|
+
},
|
|
147079
|
+
"name": "rawMessageDelivery",
|
|
147080
|
+
"optional": true,
|
|
147081
|
+
"type": {
|
|
147082
|
+
"primitive": "boolean"
|
|
147083
|
+
}
|
|
147084
|
+
},
|
|
147085
|
+
{
|
|
147086
|
+
"abstract": true,
|
|
147087
|
+
"docs": {
|
|
147088
|
+
"default": "- No subscription role is provided",
|
|
147089
|
+
"remarks": "Required for a firehose subscription protocol.",
|
|
147090
|
+
"stability": "stable",
|
|
147091
|
+
"summary": "Arn of role allowing access to firehose delivery stream."
|
|
147092
|
+
},
|
|
147093
|
+
"immutable": true,
|
|
147094
|
+
"locationInModule": {
|
|
147095
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
147096
|
+
"line": 86
|
|
147097
|
+
},
|
|
147098
|
+
"name": "subscriptionRoleArn",
|
|
147099
|
+
"optional": true,
|
|
147100
|
+
"type": {
|
|
147101
|
+
"primitive": "string"
|
|
147102
|
+
}
|
|
147103
|
+
}
|
|
147104
|
+
],
|
|
147105
|
+
"symbolId": "src/aws/notify/subscription:SubscriptionOptions"
|
|
147106
|
+
},
|
|
147107
|
+
"terraconstructs.aws.notify.SubscriptionOutputs": {
|
|
147108
|
+
"assembly": "terraconstructs",
|
|
147109
|
+
"datatype": true,
|
|
147110
|
+
"docs": {
|
|
147111
|
+
"stability": "stable",
|
|
147112
|
+
"summary": "Outputs for the Subscription construct."
|
|
147113
|
+
},
|
|
147114
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionOutputs",
|
|
147115
|
+
"kind": "interface",
|
|
147116
|
+
"locationInModule": {
|
|
147117
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
147118
|
+
"line": 15
|
|
147119
|
+
},
|
|
147120
|
+
"name": "SubscriptionOutputs",
|
|
147121
|
+
"namespace": "aws.notify",
|
|
147122
|
+
"properties": [
|
|
147123
|
+
{
|
|
147124
|
+
"abstract": true,
|
|
147125
|
+
"docs": {
|
|
147126
|
+
"stability": "stable",
|
|
147127
|
+
"summary": "The ARN of the subscription."
|
|
147128
|
+
},
|
|
147129
|
+
"immutable": true,
|
|
147130
|
+
"locationInModule": {
|
|
147131
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
147132
|
+
"line": 19
|
|
147133
|
+
},
|
|
147134
|
+
"name": "subscriptionArn",
|
|
147135
|
+
"type": {
|
|
147136
|
+
"primitive": "string"
|
|
147137
|
+
}
|
|
147138
|
+
}
|
|
147139
|
+
],
|
|
147140
|
+
"symbolId": "src/aws/notify/subscription:SubscriptionOutputs"
|
|
147141
|
+
},
|
|
147142
|
+
"terraconstructs.aws.notify.SubscriptionProps": {
|
|
147143
|
+
"assembly": "terraconstructs",
|
|
147144
|
+
"datatype": true,
|
|
147145
|
+
"docs": {
|
|
147146
|
+
"stability": "stable",
|
|
147147
|
+
"summary": "Properties for creating a new subscription."
|
|
147148
|
+
},
|
|
147149
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionProps",
|
|
147150
|
+
"interfaces": [
|
|
147151
|
+
"terraconstructs.aws.notify.SubscriptionOptions"
|
|
147152
|
+
],
|
|
147153
|
+
"kind": "interface",
|
|
147154
|
+
"locationInModule": {
|
|
147155
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
147156
|
+
"line": 98
|
|
147157
|
+
},
|
|
147158
|
+
"name": "SubscriptionProps",
|
|
147159
|
+
"namespace": "aws.notify",
|
|
147160
|
+
"properties": [
|
|
147161
|
+
{
|
|
147162
|
+
"abstract": true,
|
|
147163
|
+
"docs": {
|
|
147164
|
+
"stability": "stable",
|
|
147165
|
+
"summary": "The topic to subscribe to."
|
|
147166
|
+
},
|
|
147167
|
+
"immutable": true,
|
|
147168
|
+
"locationInModule": {
|
|
147169
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
147170
|
+
"line": 102
|
|
147171
|
+
},
|
|
147172
|
+
"name": "topic",
|
|
147173
|
+
"type": {
|
|
147174
|
+
"fqn": "terraconstructs.aws.notify.ITopic"
|
|
147175
|
+
}
|
|
147176
|
+
}
|
|
147177
|
+
],
|
|
147178
|
+
"symbolId": "src/aws/notify/subscription:SubscriptionProps"
|
|
147179
|
+
},
|
|
147180
|
+
"terraconstructs.aws.notify.SubscriptionProtocol": {
|
|
147181
|
+
"assembly": "terraconstructs",
|
|
147182
|
+
"docs": {
|
|
147183
|
+
"stability": "stable",
|
|
147184
|
+
"summary": "The type of subscription, controlling the type of the endpoint parameter."
|
|
147185
|
+
},
|
|
147186
|
+
"fqn": "terraconstructs.aws.notify.SubscriptionProtocol",
|
|
147187
|
+
"kind": "enum",
|
|
147188
|
+
"locationInModule": {
|
|
147189
|
+
"filename": "src/aws/notify/subscription.ts",
|
|
147190
|
+
"line": 416
|
|
147191
|
+
},
|
|
147192
|
+
"members": [
|
|
147193
|
+
{
|
|
147194
|
+
"docs": {
|
|
147195
|
+
"stability": "stable",
|
|
147196
|
+
"summary": "JSON-encoded message is POSTED to an HTTP url."
|
|
147197
|
+
},
|
|
147198
|
+
"name": "HTTP"
|
|
147199
|
+
},
|
|
147200
|
+
{
|
|
147201
|
+
"docs": {
|
|
147202
|
+
"stability": "stable",
|
|
147203
|
+
"summary": "JSON-encoded message is POSTed to an HTTPS url."
|
|
147204
|
+
},
|
|
147205
|
+
"name": "HTTPS"
|
|
147206
|
+
},
|
|
147207
|
+
{
|
|
147208
|
+
"docs": {
|
|
147209
|
+
"stability": "stable",
|
|
147210
|
+
"summary": "Notifications are sent via email."
|
|
147211
|
+
},
|
|
147212
|
+
"name": "EMAIL"
|
|
147213
|
+
},
|
|
147214
|
+
{
|
|
147215
|
+
"docs": {
|
|
147216
|
+
"stability": "stable",
|
|
147217
|
+
"summary": "Notifications are JSON-encoded and sent via mail."
|
|
147218
|
+
},
|
|
147219
|
+
"name": "EMAIL_JSON"
|
|
147220
|
+
},
|
|
147221
|
+
{
|
|
147222
|
+
"docs": {
|
|
147223
|
+
"stability": "stable",
|
|
147224
|
+
"summary": "Notification is delivered by SMS."
|
|
147225
|
+
},
|
|
147226
|
+
"name": "SMS"
|
|
147227
|
+
},
|
|
147228
|
+
{
|
|
147229
|
+
"docs": {
|
|
147230
|
+
"stability": "stable",
|
|
147231
|
+
"summary": "Notifications are enqueued into an SQS queue."
|
|
147232
|
+
},
|
|
147233
|
+
"name": "SQS"
|
|
147234
|
+
},
|
|
147235
|
+
{
|
|
147236
|
+
"docs": {
|
|
147237
|
+
"stability": "stable",
|
|
147238
|
+
"summary": "JSON-encoded notifications are sent to a mobile app endpoint."
|
|
147239
|
+
},
|
|
147240
|
+
"name": "APPLICATION"
|
|
147241
|
+
},
|
|
147242
|
+
{
|
|
147243
|
+
"docs": {
|
|
147244
|
+
"stability": "stable",
|
|
147245
|
+
"summary": "Notifications trigger a Lambda function."
|
|
147246
|
+
},
|
|
147247
|
+
"name": "LAMBDA"
|
|
147248
|
+
},
|
|
147249
|
+
{
|
|
147250
|
+
"docs": {
|
|
147251
|
+
"stability": "stable",
|
|
147252
|
+
"summary": "Notifications put records into a firehose delivery stream."
|
|
147253
|
+
},
|
|
147254
|
+
"name": "FIREHOSE"
|
|
147255
|
+
}
|
|
147256
|
+
],
|
|
147257
|
+
"name": "SubscriptionProtocol",
|
|
147258
|
+
"namespace": "aws.notify",
|
|
147259
|
+
"symbolId": "src/aws/notify/subscription:SubscriptionProtocol"
|
|
147260
|
+
},
|
|
147261
|
+
"terraconstructs.aws.notify.ThrottlePolicy": {
|
|
147262
|
+
"assembly": "terraconstructs",
|
|
147263
|
+
"datatype": true,
|
|
147264
|
+
"docs": {
|
|
147265
|
+
"stability": "stable",
|
|
147266
|
+
"summary": "Options for customising AWS SNS HTTP/S delivery throttling."
|
|
147267
|
+
},
|
|
147268
|
+
"fqn": "terraconstructs.aws.notify.ThrottlePolicy",
|
|
147269
|
+
"kind": "interface",
|
|
147270
|
+
"locationInModule": {
|
|
147271
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
147272
|
+
"line": 30
|
|
147273
|
+
},
|
|
147274
|
+
"name": "ThrottlePolicy",
|
|
147275
|
+
"namespace": "aws.notify",
|
|
147276
|
+
"properties": [
|
|
147277
|
+
{
|
|
147278
|
+
"abstract": true,
|
|
147279
|
+
"docs": {
|
|
147280
|
+
"default": "- no throttling",
|
|
147281
|
+
"stability": "stable",
|
|
147282
|
+
"summary": "The maximum number of deliveries per second, per subscription."
|
|
147283
|
+
},
|
|
147284
|
+
"immutable": true,
|
|
147285
|
+
"locationInModule": {
|
|
147286
|
+
"filename": "src/aws/notify/delivery-policy.ts",
|
|
147287
|
+
"line": 36
|
|
147288
|
+
},
|
|
147289
|
+
"name": "maxReceivesPerSecond",
|
|
147290
|
+
"optional": true,
|
|
147291
|
+
"type": {
|
|
147292
|
+
"primitive": "number"
|
|
147293
|
+
}
|
|
147294
|
+
}
|
|
147295
|
+
],
|
|
147296
|
+
"symbolId": "src/aws/notify/delivery-policy:ThrottlePolicy"
|
|
147297
|
+
},
|
|
147298
|
+
"terraconstructs.aws.notify.Topic": {
|
|
147299
|
+
"assembly": "terraconstructs",
|
|
147300
|
+
"base": "terraconstructs.aws.notify.TopicBase",
|
|
147301
|
+
"docs": {
|
|
147302
|
+
"custom": {
|
|
147303
|
+
"resource": "aws_sns_topic"
|
|
147304
|
+
},
|
|
147305
|
+
"stability": "stable",
|
|
147306
|
+
"summary": "A new SNS topic."
|
|
147307
|
+
},
|
|
147308
|
+
"fqn": "terraconstructs.aws.notify.Topic",
|
|
147309
|
+
"initializer": {
|
|
147310
|
+
"docs": {
|
|
147311
|
+
"stability": "stable"
|
|
147312
|
+
},
|
|
147313
|
+
"locationInModule": {
|
|
147314
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147315
|
+
"line": 315
|
|
147316
|
+
},
|
|
147317
|
+
"parameters": [
|
|
147318
|
+
{
|
|
147319
|
+
"name": "scope",
|
|
147320
|
+
"type": {
|
|
147321
|
+
"fqn": "constructs.Construct"
|
|
147322
|
+
}
|
|
147323
|
+
},
|
|
147324
|
+
{
|
|
147325
|
+
"name": "id",
|
|
147326
|
+
"type": {
|
|
147327
|
+
"primitive": "string"
|
|
147328
|
+
}
|
|
147329
|
+
},
|
|
147330
|
+
{
|
|
147331
|
+
"name": "props",
|
|
147332
|
+
"optional": true,
|
|
147333
|
+
"type": {
|
|
147334
|
+
"fqn": "terraconstructs.aws.notify.TopicProps"
|
|
147335
|
+
}
|
|
147336
|
+
}
|
|
147337
|
+
]
|
|
147338
|
+
},
|
|
147339
|
+
"kind": "class",
|
|
147340
|
+
"locationInModule": {
|
|
147341
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147342
|
+
"line": 247
|
|
147343
|
+
},
|
|
147344
|
+
"methods": [
|
|
147345
|
+
{
|
|
147346
|
+
"docs": {
|
|
147347
|
+
"stability": "stable",
|
|
147348
|
+
"summary": "Import an existing SNS topic provided an ARN."
|
|
147349
|
+
},
|
|
147350
|
+
"locationInModule": {
|
|
147351
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147352
|
+
"line": 255
|
|
147353
|
+
},
|
|
147354
|
+
"name": "fromTopicArn",
|
|
147355
|
+
"parameters": [
|
|
147356
|
+
{
|
|
147357
|
+
"docs": {
|
|
147358
|
+
"summary": "The parent creating construct."
|
|
147359
|
+
},
|
|
147360
|
+
"name": "scope",
|
|
147361
|
+
"type": {
|
|
147362
|
+
"fqn": "constructs.Construct"
|
|
147363
|
+
}
|
|
147364
|
+
},
|
|
147365
|
+
{
|
|
147366
|
+
"docs": {
|
|
147367
|
+
"summary": "The construct's name."
|
|
147368
|
+
},
|
|
147369
|
+
"name": "id",
|
|
147370
|
+
"type": {
|
|
147371
|
+
"primitive": "string"
|
|
147372
|
+
}
|
|
147373
|
+
},
|
|
147374
|
+
{
|
|
147375
|
+
"docs": {
|
|
147376
|
+
"summary": "topic ARN (i.e. arn:aws:sns:us-east-2:444455556666:MyTopic)."
|
|
147377
|
+
},
|
|
147378
|
+
"name": "topicArn",
|
|
147379
|
+
"type": {
|
|
147380
|
+
"primitive": "string"
|
|
147381
|
+
}
|
|
147382
|
+
}
|
|
147383
|
+
],
|
|
147384
|
+
"returns": {
|
|
147385
|
+
"type": {
|
|
147386
|
+
"fqn": "terraconstructs.aws.notify.ITopic"
|
|
147387
|
+
}
|
|
147388
|
+
},
|
|
147389
|
+
"static": true
|
|
147390
|
+
},
|
|
147391
|
+
{
|
|
147392
|
+
"docs": {
|
|
147393
|
+
"stability": "stable",
|
|
147394
|
+
"summary": "Import an existing SNS topic provided a topic attributes."
|
|
147395
|
+
},
|
|
147396
|
+
"locationInModule": {
|
|
147397
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147398
|
+
"line": 270
|
|
147399
|
+
},
|
|
147400
|
+
"name": "fromTopicAttributes",
|
|
147401
|
+
"parameters": [
|
|
147402
|
+
{
|
|
147403
|
+
"docs": {
|
|
147404
|
+
"summary": "The parent creating construct."
|
|
147405
|
+
},
|
|
147406
|
+
"name": "scope",
|
|
147407
|
+
"type": {
|
|
147408
|
+
"fqn": "constructs.Construct"
|
|
147409
|
+
}
|
|
147410
|
+
},
|
|
147411
|
+
{
|
|
147412
|
+
"docs": {
|
|
147413
|
+
"summary": "The construct's name."
|
|
147414
|
+
},
|
|
147415
|
+
"name": "id",
|
|
147416
|
+
"type": {
|
|
147417
|
+
"primitive": "string"
|
|
147418
|
+
}
|
|
147419
|
+
},
|
|
147420
|
+
{
|
|
147421
|
+
"docs": {
|
|
147422
|
+
"summary": "the attributes of the topic to import."
|
|
147423
|
+
},
|
|
147424
|
+
"name": "attrs",
|
|
147425
|
+
"type": {
|
|
147426
|
+
"fqn": "terraconstructs.aws.notify.TopicAttributes"
|
|
147427
|
+
}
|
|
147428
|
+
}
|
|
147429
|
+
],
|
|
147430
|
+
"returns": {
|
|
147431
|
+
"type": {
|
|
147432
|
+
"fqn": "terraconstructs.aws.notify.ITopic"
|
|
147433
|
+
}
|
|
147434
|
+
},
|
|
147435
|
+
"static": true
|
|
147436
|
+
},
|
|
147437
|
+
{
|
|
147438
|
+
"docs": {
|
|
147439
|
+
"stability": "stable",
|
|
147440
|
+
"summary": "Adds a delivery status logging configuration to the topic."
|
|
147441
|
+
},
|
|
147442
|
+
"locationInModule": {
|
|
147443
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147444
|
+
"line": 416
|
|
147445
|
+
},
|
|
147446
|
+
"name": "addLoggingConfig",
|
|
147447
|
+
"parameters": [
|
|
147448
|
+
{
|
|
147449
|
+
"name": "config",
|
|
147450
|
+
"type": {
|
|
147451
|
+
"fqn": "terraconstructs.aws.notify.LoggingConfig"
|
|
147452
|
+
}
|
|
147453
|
+
}
|
|
147454
|
+
]
|
|
147455
|
+
},
|
|
147456
|
+
{
|
|
147457
|
+
"docs": {
|
|
147458
|
+
"see": "https://docs.aws.amazon.com/sns/latest/dg/sns-security-best-practices.html#enforce-encryption-data-in-transit",
|
|
147459
|
+
"stability": "stable",
|
|
147460
|
+
"summary": "Adds an IAM policy statement to enforce the use of TLS for publishing to this topic."
|
|
147461
|
+
},
|
|
147462
|
+
"locationInModule": {
|
|
147463
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147464
|
+
"line": 453
|
|
147465
|
+
},
|
|
147466
|
+
"name": "addSSLPolicy",
|
|
147467
|
+
"overrides": "terraconstructs.aws.notify.TopicBase",
|
|
147468
|
+
"protected": true
|
|
147469
|
+
}
|
|
147470
|
+
],
|
|
147471
|
+
"name": "Topic",
|
|
147472
|
+
"namespace": "aws.notify",
|
|
147473
|
+
"properties": [
|
|
147474
|
+
{
|
|
147475
|
+
"docs": {
|
|
147476
|
+
"remarks": "Set by subclasses.",
|
|
147477
|
+
"stability": "stable",
|
|
147478
|
+
"summary": "Controls automatic creation of policy objects."
|
|
147479
|
+
},
|
|
147480
|
+
"immutable": true,
|
|
147481
|
+
"locationInModule": {
|
|
147482
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147483
|
+
"line": 311
|
|
147484
|
+
},
|
|
147485
|
+
"name": "autoCreatePolicy",
|
|
147486
|
+
"overrides": "terraconstructs.aws.notify.TopicBase",
|
|
147487
|
+
"protected": true,
|
|
147488
|
+
"type": {
|
|
147489
|
+
"primitive": "boolean"
|
|
147490
|
+
}
|
|
147491
|
+
},
|
|
147492
|
+
{
|
|
147493
|
+
"docs": {
|
|
147494
|
+
"stability": "stable",
|
|
147495
|
+
"summary": "Enables content-based deduplication for FIFO topics."
|
|
147496
|
+
},
|
|
147497
|
+
"immutable": true,
|
|
147498
|
+
"locationInModule": {
|
|
147499
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147500
|
+
"line": 308
|
|
147501
|
+
},
|
|
147502
|
+
"name": "contentBasedDeduplication",
|
|
147503
|
+
"overrides": "terraconstructs.aws.notify.TopicBase",
|
|
147504
|
+
"type": {
|
|
147505
|
+
"primitive": "boolean"
|
|
147506
|
+
}
|
|
147507
|
+
},
|
|
147508
|
+
{
|
|
147509
|
+
"docs": {
|
|
147510
|
+
"remarks": "If false, this is a standard topic.",
|
|
147511
|
+
"stability": "stable",
|
|
147512
|
+
"summary": "Whether this topic is an Amazon SNS FIFO queue."
|
|
147513
|
+
},
|
|
147514
|
+
"immutable": true,
|
|
147515
|
+
"locationInModule": {
|
|
147516
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147517
|
+
"line": 309
|
|
147518
|
+
},
|
|
147519
|
+
"name": "fifo",
|
|
147520
|
+
"overrides": "terraconstructs.aws.notify.TopicBase",
|
|
147521
|
+
"type": {
|
|
147522
|
+
"primitive": "boolean"
|
|
147523
|
+
}
|
|
147524
|
+
},
|
|
147525
|
+
{
|
|
147526
|
+
"docs": {
|
|
147527
|
+
"stability": "stable",
|
|
147528
|
+
"summary": "The ARN of the topic."
|
|
147529
|
+
},
|
|
147530
|
+
"immutable": true,
|
|
147531
|
+
"locationInModule": {
|
|
147532
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147533
|
+
"line": 305
|
|
147534
|
+
},
|
|
147535
|
+
"name": "topicArn",
|
|
147536
|
+
"overrides": "terraconstructs.aws.notify.TopicBase",
|
|
147537
|
+
"type": {
|
|
147538
|
+
"primitive": "string"
|
|
147539
|
+
}
|
|
147540
|
+
},
|
|
147541
|
+
{
|
|
147542
|
+
"docs": {
|
|
147543
|
+
"stability": "stable",
|
|
147544
|
+
"summary": "The name of the topic."
|
|
147545
|
+
},
|
|
147546
|
+
"immutable": true,
|
|
147547
|
+
"locationInModule": {
|
|
147548
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147549
|
+
"line": 306
|
|
147550
|
+
},
|
|
147551
|
+
"name": "topicName",
|
|
147552
|
+
"overrides": "terraconstructs.aws.notify.TopicBase",
|
|
147553
|
+
"type": {
|
|
147554
|
+
"primitive": "string"
|
|
147555
|
+
}
|
|
147556
|
+
},
|
|
147557
|
+
{
|
|
147558
|
+
"docs": {
|
|
147559
|
+
"remarks": "This property applies only to server-side encryption.",
|
|
147560
|
+
"stability": "stable",
|
|
147561
|
+
"summary": "A KMS Key, either managed by this CDK app, or imported."
|
|
147562
|
+
},
|
|
147563
|
+
"immutable": true,
|
|
147564
|
+
"locationInModule": {
|
|
147565
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147566
|
+
"line": 307
|
|
147567
|
+
},
|
|
147568
|
+
"name": "masterKey",
|
|
147569
|
+
"optional": true,
|
|
147570
|
+
"overrides": "terraconstructs.aws.notify.TopicBase",
|
|
147571
|
+
"type": {
|
|
147572
|
+
"fqn": "terraconstructs.aws.encryption.IKey"
|
|
147573
|
+
}
|
|
147574
|
+
}
|
|
147575
|
+
],
|
|
147576
|
+
"symbolId": "src/aws/notify/topic:Topic"
|
|
147577
|
+
},
|
|
147578
|
+
"terraconstructs.aws.notify.TopicAttributes": {
|
|
147579
|
+
"assembly": "terraconstructs",
|
|
147580
|
+
"datatype": true,
|
|
147581
|
+
"docs": {
|
|
147582
|
+
"stability": "stable",
|
|
147583
|
+
"summary": "Represents an SNS topic defined outside of this stack."
|
|
147584
|
+
},
|
|
147585
|
+
"fqn": "terraconstructs.aws.notify.TopicAttributes",
|
|
147586
|
+
"kind": "interface",
|
|
147587
|
+
"locationInModule": {
|
|
147588
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147589
|
+
"line": 220
|
|
147590
|
+
},
|
|
147591
|
+
"name": "TopicAttributes",
|
|
147592
|
+
"namespace": "aws.notify",
|
|
147593
|
+
"properties": [
|
|
147594
|
+
{
|
|
147595
|
+
"abstract": true,
|
|
147596
|
+
"docs": {
|
|
147597
|
+
"stability": "stable",
|
|
147598
|
+
"summary": "The ARN of the SNS topic."
|
|
147599
|
+
},
|
|
147600
|
+
"immutable": true,
|
|
147601
|
+
"locationInModule": {
|
|
147602
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147603
|
+
"line": 224
|
|
147604
|
+
},
|
|
147605
|
+
"name": "topicArn",
|
|
147606
|
+
"type": {
|
|
147607
|
+
"primitive": "string"
|
|
147608
|
+
}
|
|
147609
|
+
},
|
|
147610
|
+
{
|
|
147611
|
+
"abstract": true,
|
|
147612
|
+
"docs": {
|
|
147613
|
+
"default": "false",
|
|
147614
|
+
"remarks": "Only applicable for FIFO topics.",
|
|
147615
|
+
"stability": "stable",
|
|
147616
|
+
"summary": "Whether content-based deduplication is enabled."
|
|
147617
|
+
},
|
|
147618
|
+
"immutable": true,
|
|
147619
|
+
"locationInModule": {
|
|
147620
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147621
|
+
"line": 239
|
|
147622
|
+
},
|
|
147623
|
+
"name": "contentBasedDeduplication",
|
|
147624
|
+
"optional": true,
|
|
147625
|
+
"type": {
|
|
147626
|
+
"primitive": "boolean"
|
|
147627
|
+
}
|
|
147628
|
+
},
|
|
147629
|
+
{
|
|
147630
|
+
"abstract": true,
|
|
147631
|
+
"docs": {
|
|
147632
|
+
"default": "- None",
|
|
147633
|
+
"stability": "stable",
|
|
147634
|
+
"summary": "KMS encryption key ARN, if this topic is server-side encrypted by a KMS key."
|
|
147635
|
+
},
|
|
147636
|
+
"immutable": true,
|
|
147637
|
+
"locationInModule": {
|
|
147638
|
+
"filename": "src/aws/notify/topic.ts",
|
|
147639
|
+
"line": 231
|
|
147640
|
+
},
|
|
147641
|
+
"name": "keyArn",
|
|
147642
|
+
"optional": true,
|
|
147643
|
+
"type": {
|
|
147644
|
+
"primitive": "string"
|
|
147645
|
+
}
|
|
147646
|
+
}
|
|
147647
|
+
],
|
|
147648
|
+
"symbolId": "src/aws/notify/topic:TopicAttributes"
|
|
147649
|
+
},
|
|
147650
|
+
"terraconstructs.aws.notify.TopicBase": {
|
|
147651
|
+
"abstract": true,
|
|
147652
|
+
"assembly": "terraconstructs",
|
|
147653
|
+
"base": "terraconstructs.aws.AwsConstructBase",
|
|
147654
|
+
"docs": {
|
|
147655
|
+
"stability": "stable",
|
|
147656
|
+
"summary": "Either a new or imported Topic."
|
|
147657
|
+
},
|
|
147658
|
+
"fqn": "terraconstructs.aws.notify.TopicBase",
|
|
147659
|
+
"initializer": {
|
|
147660
|
+
"docs": {
|
|
147661
|
+
"stability": "stable"
|
|
147662
|
+
},
|
|
147663
|
+
"locationInModule": {
|
|
147664
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
147665
|
+
"line": 155
|
|
147666
|
+
},
|
|
147667
|
+
"parameters": [
|
|
147668
|
+
{
|
|
147669
|
+
"name": "scope",
|
|
147670
|
+
"type": {
|
|
147671
|
+
"fqn": "constructs.Construct"
|
|
147672
|
+
}
|
|
147673
|
+
},
|
|
147674
|
+
{
|
|
147675
|
+
"name": "id",
|
|
147676
|
+
"type": {
|
|
147677
|
+
"primitive": "string"
|
|
147678
|
+
}
|
|
147679
|
+
},
|
|
147680
|
+
{
|
|
147681
|
+
"name": "props",
|
|
147682
|
+
"optional": true,
|
|
147683
|
+
"type": {
|
|
147684
|
+
"fqn": "terraconstructs.aws.AwsConstructProps"
|
|
147685
|
+
}
|
|
147686
|
+
}
|
|
147687
|
+
]
|
|
147688
|
+
},
|
|
147689
|
+
"interfaces": [
|
|
147690
|
+
"terraconstructs.aws.notify.ITopic"
|
|
147691
|
+
],
|
|
147692
|
+
"kind": "class",
|
|
147693
|
+
"locationInModule": {
|
|
147694
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
147695
|
+
"line": 121
|
|
147696
|
+
},
|
|
147697
|
+
"methods": [
|
|
147698
|
+
{
|
|
147699
|
+
"docs": {
|
|
147700
|
+
"stability": "stable",
|
|
147701
|
+
"summary": "Adds a SSL policy to the topic resource policy."
|
|
147702
|
+
},
|
|
147703
|
+
"locationInModule": {
|
|
147704
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
147705
|
+
"line": 225
|
|
147706
|
+
},
|
|
147707
|
+
"name": "addSSLPolicy",
|
|
147708
|
+
"protected": true
|
|
147709
|
+
},
|
|
147710
|
+
{
|
|
147711
|
+
"docs": {
|
|
147712
|
+
"stability": "stable",
|
|
147713
|
+
"summary": "Subscribe some endpoint to this topic."
|
|
147714
|
+
},
|
|
147715
|
+
"locationInModule": {
|
|
147716
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
147717
|
+
"line": 166
|
|
147718
|
+
},
|
|
147719
|
+
"name": "addSubscription",
|
|
147720
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
147721
|
+
"parameters": [
|
|
147722
|
+
{
|
|
147723
|
+
"name": "topicSubscription",
|
|
147724
|
+
"type": {
|
|
147725
|
+
"fqn": "terraconstructs.aws.notify.ITopicSubscription"
|
|
147726
|
+
}
|
|
147727
|
+
}
|
|
147728
|
+
],
|
|
147729
|
+
"returns": {
|
|
147730
|
+
"type": {
|
|
147731
|
+
"fqn": "terraconstructs.aws.notify.Subscription"
|
|
147732
|
+
}
|
|
147733
|
+
}
|
|
147734
|
+
},
|
|
147735
|
+
{
|
|
147736
|
+
"docs": {
|
|
147737
|
+
"remarks": "If this topic was created in this stack (`new Topic`), a topic policy\nwill be automatically created upon the first call to `addToResourcePolicy`.\nHowever, if `enforceSSL` is set to `true`, the policy has already been created\nbefore the first call to this method.\n\nIf the topic is imported (`Topic.import`), then this is a no-op.",
|
|
147738
|
+
"stability": "stable",
|
|
147739
|
+
"summary": "Adds a statement to the IAM resource policy associated with this topic."
|
|
147740
|
+
},
|
|
147741
|
+
"locationInModule": {
|
|
147742
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
147743
|
+
"line": 210
|
|
147744
|
+
},
|
|
147745
|
+
"name": "addToResourcePolicy",
|
|
147746
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
147747
|
+
"parameters": [
|
|
147748
|
+
{
|
|
147749
|
+
"name": "statement",
|
|
147750
|
+
"type": {
|
|
147751
|
+
"fqn": "terraconstructs.aws.iam.PolicyStatement"
|
|
147752
|
+
}
|
|
147753
|
+
}
|
|
147754
|
+
],
|
|
147755
|
+
"returns": {
|
|
147756
|
+
"type": {
|
|
147757
|
+
"fqn": "terraconstructs.aws.iam.AddToResourcePolicyResult"
|
|
147758
|
+
}
|
|
147759
|
+
}
|
|
147760
|
+
},
|
|
147761
|
+
{
|
|
147762
|
+
"docs": {
|
|
147763
|
+
"stability": "stable",
|
|
147764
|
+
"summary": "Represents a notification target That allows SNS topic to associate with this rule target."
|
|
147765
|
+
},
|
|
147766
|
+
"locationInModule": {
|
|
147767
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
147768
|
+
"line": 296
|
|
147769
|
+
},
|
|
147770
|
+
"name": "bindAsNotificationRuleTarget",
|
|
147771
|
+
"overrides": "terraconstructs.aws.notify.INotificationRuleTarget",
|
|
147772
|
+
"parameters": [
|
|
147773
|
+
{
|
|
147774
|
+
"name": "_scope",
|
|
147775
|
+
"type": {
|
|
147776
|
+
"fqn": "constructs.Construct"
|
|
147777
|
+
}
|
|
147778
|
+
}
|
|
147779
|
+
],
|
|
147780
|
+
"returns": {
|
|
147781
|
+
"type": {
|
|
147782
|
+
"fqn": "terraconstructs.aws.notify.NotificationRuleTargetConfig"
|
|
147783
|
+
}
|
|
147784
|
+
}
|
|
147785
|
+
},
|
|
147786
|
+
{
|
|
147787
|
+
"docs": {
|
|
147788
|
+
"remarks": "For more information, see https://docs.aws.amazon.com/sns/latest/dg/sns-security-best-practices.html#enforce-encryption-data-in-transit.",
|
|
147789
|
+
"stability": "stable",
|
|
147790
|
+
"summary": "Adds a statement to enforce encryption of data in transit when publishing to the topic."
|
|
147791
|
+
},
|
|
147792
|
+
"locationInModule": {
|
|
147793
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
147794
|
+
"line": 247
|
|
147795
|
+
},
|
|
147796
|
+
"name": "createSSLPolicyDocument",
|
|
147797
|
+
"protected": true,
|
|
147798
|
+
"returns": {
|
|
147799
|
+
"type": {
|
|
147800
|
+
"fqn": "terraconstructs.aws.iam.PolicyStatement"
|
|
147801
|
+
}
|
|
147802
|
+
}
|
|
147803
|
+
},
|
|
147804
|
+
{
|
|
147805
|
+
"docs": {
|
|
147806
|
+
"stability": "stable",
|
|
147807
|
+
"summary": "Creates a topic policy for this topic."
|
|
147808
|
+
},
|
|
147809
|
+
"locationInModule": {
|
|
147810
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
147811
|
+
"line": 236
|
|
147812
|
+
},
|
|
147813
|
+
"name": "createTopicPolicy",
|
|
147814
|
+
"protected": true
|
|
147815
|
+
},
|
|
147816
|
+
{
|
|
147817
|
+
"docs": {
|
|
147818
|
+
"stability": "stable",
|
|
147819
|
+
"summary": "Grant topic publishing permissions to the given identity."
|
|
147820
|
+
},
|
|
147821
|
+
"locationInModule": {
|
|
147822
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
147823
|
+
"line": 267
|
|
147824
|
+
},
|
|
147825
|
+
"name": "grantPublish",
|
|
147826
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
147827
|
+
"parameters": [
|
|
147828
|
+
{
|
|
147829
|
+
"name": "grantee",
|
|
147830
|
+
"type": {
|
|
147831
|
+
"fqn": "terraconstructs.aws.iam.IGrantable"
|
|
147832
|
+
}
|
|
147833
|
+
}
|
|
147834
|
+
],
|
|
147835
|
+
"returns": {
|
|
147836
|
+
"type": {
|
|
147837
|
+
"fqn": "terraconstructs.aws.iam.Grant"
|
|
147838
|
+
}
|
|
147839
|
+
}
|
|
147840
|
+
},
|
|
147841
|
+
{
|
|
147842
|
+
"docs": {
|
|
147843
|
+
"stability": "stable",
|
|
147844
|
+
"summary": "Grant topic subscribing permissions to the given identity."
|
|
147845
|
+
},
|
|
147846
|
+
"locationInModule": {
|
|
147847
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
147848
|
+
"line": 283
|
|
147849
|
+
},
|
|
147850
|
+
"name": "grantSubscribe",
|
|
147851
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
147852
|
+
"parameters": [
|
|
147853
|
+
{
|
|
147854
|
+
"name": "grantee",
|
|
147855
|
+
"type": {
|
|
147856
|
+
"fqn": "terraconstructs.aws.iam.IGrantable"
|
|
147857
|
+
}
|
|
147858
|
+
}
|
|
147859
|
+
],
|
|
147860
|
+
"returns": {
|
|
147861
|
+
"type": {
|
|
147862
|
+
"fqn": "terraconstructs.aws.iam.Grant"
|
|
147863
|
+
}
|
|
147864
|
+
}
|
|
147865
|
+
},
|
|
147866
|
+
{
|
|
147867
|
+
"docs": {
|
|
147868
|
+
"stability": "stable",
|
|
147869
|
+
"summary": "Return the given named metric for this Topic."
|
|
147870
|
+
},
|
|
147871
|
+
"locationInModule": {
|
|
147872
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
147873
|
+
"line": 85
|
|
147874
|
+
},
|
|
147875
|
+
"name": "metric",
|
|
147876
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
147877
|
+
"parameters": [
|
|
147878
|
+
{
|
|
147879
|
+
"name": "metricName",
|
|
147880
|
+
"type": {
|
|
147881
|
+
"primitive": "string"
|
|
147882
|
+
}
|
|
147883
|
+
},
|
|
147884
|
+
{
|
|
147885
|
+
"name": "props",
|
|
147886
|
+
"optional": true,
|
|
147887
|
+
"type": {
|
|
147888
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
147889
|
+
}
|
|
147890
|
+
}
|
|
147891
|
+
],
|
|
147892
|
+
"returns": {
|
|
147893
|
+
"type": {
|
|
147894
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
147895
|
+
}
|
|
147896
|
+
}
|
|
147897
|
+
},
|
|
147898
|
+
{
|
|
147899
|
+
"docs": {
|
|
147900
|
+
"remarks": "Sum over 5 minutes",
|
|
147901
|
+
"stability": "stable",
|
|
147902
|
+
"summary": "The number of messages published to your Amazon SNS topics."
|
|
147903
|
+
},
|
|
147904
|
+
"locationInModule": {
|
|
147905
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
147906
|
+
"line": 99
|
|
147907
|
+
},
|
|
147908
|
+
"name": "metricNumberOfMessagesPublished",
|
|
147909
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
147910
|
+
"parameters": [
|
|
147911
|
+
{
|
|
147912
|
+
"name": "props",
|
|
147913
|
+
"optional": true,
|
|
147914
|
+
"type": {
|
|
147915
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
147916
|
+
}
|
|
147917
|
+
}
|
|
147918
|
+
],
|
|
147919
|
+
"returns": {
|
|
147920
|
+
"type": {
|
|
147921
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
147922
|
+
}
|
|
147923
|
+
}
|
|
147924
|
+
},
|
|
147925
|
+
{
|
|
147926
|
+
"docs": {
|
|
147927
|
+
"remarks": "Sum over 5 minutes",
|
|
147928
|
+
"stability": "stable",
|
|
147929
|
+
"summary": "The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints."
|
|
147930
|
+
},
|
|
147931
|
+
"locationInModule": {
|
|
147932
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
147933
|
+
"line": 106
|
|
147934
|
+
},
|
|
147935
|
+
"name": "metricNumberOfNotificationsDelivered",
|
|
147936
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
147937
|
+
"parameters": [
|
|
147938
|
+
{
|
|
147939
|
+
"name": "props",
|
|
147940
|
+
"optional": true,
|
|
147941
|
+
"type": {
|
|
147942
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
147943
|
+
}
|
|
147944
|
+
}
|
|
147945
|
+
],
|
|
147946
|
+
"returns": {
|
|
147947
|
+
"type": {
|
|
147948
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
147949
|
+
}
|
|
147950
|
+
}
|
|
147951
|
+
},
|
|
147952
|
+
{
|
|
147953
|
+
"docs": {
|
|
147954
|
+
"remarks": "Sum over 5 minutes",
|
|
147955
|
+
"stability": "stable",
|
|
147956
|
+
"summary": "The number of messages that Amazon SNS failed to deliver."
|
|
147957
|
+
},
|
|
147958
|
+
"locationInModule": {
|
|
147959
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
147960
|
+
"line": 113
|
|
147961
|
+
},
|
|
147962
|
+
"name": "metricNumberOfNotificationsFailed",
|
|
147963
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
147964
|
+
"parameters": [
|
|
147965
|
+
{
|
|
147966
|
+
"name": "props",
|
|
147967
|
+
"optional": true,
|
|
147968
|
+
"type": {
|
|
147969
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
147970
|
+
}
|
|
147971
|
+
}
|
|
147972
|
+
],
|
|
147973
|
+
"returns": {
|
|
147974
|
+
"type": {
|
|
147975
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
147976
|
+
}
|
|
147977
|
+
}
|
|
147978
|
+
},
|
|
147979
|
+
{
|
|
147980
|
+
"docs": {
|
|
147981
|
+
"remarks": "Sum over 5 minutes",
|
|
147982
|
+
"stability": "stable",
|
|
147983
|
+
"summary": "The number of messages that were rejected by subscription filter policies."
|
|
147984
|
+
},
|
|
147985
|
+
"locationInModule": {
|
|
147986
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
147987
|
+
"line": 120
|
|
147988
|
+
},
|
|
147989
|
+
"name": "metricNumberOfNotificationsFilteredOut",
|
|
147990
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
147991
|
+
"parameters": [
|
|
147992
|
+
{
|
|
147993
|
+
"name": "props",
|
|
147994
|
+
"optional": true,
|
|
147995
|
+
"type": {
|
|
147996
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
147997
|
+
}
|
|
147998
|
+
}
|
|
147999
|
+
],
|
|
148000
|
+
"returns": {
|
|
148001
|
+
"type": {
|
|
148002
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
148003
|
+
}
|
|
148004
|
+
}
|
|
148005
|
+
},
|
|
148006
|
+
{
|
|
148007
|
+
"docs": {
|
|
148008
|
+
"remarks": "Sum over 5 minutes",
|
|
148009
|
+
"stability": "stable",
|
|
148010
|
+
"summary": "The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid."
|
|
148011
|
+
},
|
|
148012
|
+
"locationInModule": {
|
|
148013
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
148014
|
+
"line": 134
|
|
148015
|
+
},
|
|
148016
|
+
"name": "metricNumberOfNotificationsFilteredOutInvalidAttributes",
|
|
148017
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
148018
|
+
"parameters": [
|
|
148019
|
+
{
|
|
148020
|
+
"name": "props",
|
|
148021
|
+
"optional": true,
|
|
148022
|
+
"type": {
|
|
148023
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
148024
|
+
}
|
|
148025
|
+
}
|
|
148026
|
+
],
|
|
148027
|
+
"returns": {
|
|
148028
|
+
"type": {
|
|
148029
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
148030
|
+
}
|
|
148031
|
+
}
|
|
148032
|
+
},
|
|
148033
|
+
{
|
|
148034
|
+
"docs": {
|
|
148035
|
+
"remarks": "Sum over 5 minutes",
|
|
148036
|
+
"stability": "stable",
|
|
148037
|
+
"summary": "The number of messages that were rejected by subscription filter policies because the messages have no attributes."
|
|
148038
|
+
},
|
|
148039
|
+
"locationInModule": {
|
|
148040
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
148041
|
+
"line": 127
|
|
148042
|
+
},
|
|
148043
|
+
"name": "metricNumberOfNotificationsFilteredOutNoMessageAttributes",
|
|
148044
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
148045
|
+
"parameters": [
|
|
148046
|
+
{
|
|
148047
|
+
"name": "props",
|
|
148048
|
+
"optional": true,
|
|
148049
|
+
"type": {
|
|
148050
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
148051
|
+
}
|
|
148052
|
+
}
|
|
148053
|
+
],
|
|
148054
|
+
"returns": {
|
|
148055
|
+
"type": {
|
|
148056
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
148057
|
+
}
|
|
148058
|
+
}
|
|
148059
|
+
},
|
|
148060
|
+
{
|
|
148061
|
+
"docs": {
|
|
148062
|
+
"remarks": "Average over 5 minutes",
|
|
148063
|
+
"stability": "stable",
|
|
148064
|
+
"summary": "Metric for the size of messages published through this topic."
|
|
148065
|
+
},
|
|
148066
|
+
"locationInModule": {
|
|
148067
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
148068
|
+
"line": 92
|
|
148069
|
+
},
|
|
148070
|
+
"name": "metricPublishSize",
|
|
148071
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
148072
|
+
"parameters": [
|
|
148073
|
+
{
|
|
148074
|
+
"name": "props",
|
|
148075
|
+
"optional": true,
|
|
148076
|
+
"type": {
|
|
148077
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
148078
|
+
}
|
|
148079
|
+
}
|
|
148080
|
+
],
|
|
148081
|
+
"returns": {
|
|
148082
|
+
"type": {
|
|
148083
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
148084
|
+
}
|
|
148085
|
+
}
|
|
148086
|
+
},
|
|
148087
|
+
{
|
|
148088
|
+
"docs": {
|
|
148089
|
+
"remarks": "Maximum over 5 minutes",
|
|
148090
|
+
"stability": "stable",
|
|
148091
|
+
"summary": "The charges you have accrued since the start of the current calendar month for sending SMS messages."
|
|
148092
|
+
},
|
|
148093
|
+
"locationInModule": {
|
|
148094
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
148095
|
+
"line": 141
|
|
148096
|
+
},
|
|
148097
|
+
"name": "metricSMSMonthToDateSpentUSD",
|
|
148098
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
148099
|
+
"parameters": [
|
|
148100
|
+
{
|
|
148101
|
+
"name": "props",
|
|
148102
|
+
"optional": true,
|
|
148103
|
+
"type": {
|
|
148104
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
148105
|
+
}
|
|
148106
|
+
}
|
|
148107
|
+
],
|
|
148108
|
+
"returns": {
|
|
148109
|
+
"type": {
|
|
148110
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
148111
|
+
}
|
|
148112
|
+
}
|
|
148113
|
+
},
|
|
148114
|
+
{
|
|
148115
|
+
"docs": {
|
|
148116
|
+
"remarks": "Sum over 5 minutes",
|
|
148117
|
+
"stability": "stable",
|
|
148118
|
+
"summary": "The rate of successful SMS message deliveries."
|
|
148119
|
+
},
|
|
148120
|
+
"locationInModule": {
|
|
148121
|
+
"filename": "src/aws/notify/sns-augmentations.generated.ts",
|
|
148122
|
+
"line": 148
|
|
148123
|
+
},
|
|
148124
|
+
"name": "metricSMSSuccessRate",
|
|
148125
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
148126
|
+
"parameters": [
|
|
148127
|
+
{
|
|
148128
|
+
"name": "props",
|
|
148129
|
+
"optional": true,
|
|
148130
|
+
"type": {
|
|
148131
|
+
"fqn": "terraconstructs.aws.cloudwatch.MetricOptions"
|
|
148132
|
+
}
|
|
148133
|
+
}
|
|
148134
|
+
],
|
|
148135
|
+
"returns": {
|
|
148136
|
+
"type": {
|
|
148137
|
+
"fqn": "terraconstructs.aws.cloudwatch.Metric"
|
|
148138
|
+
}
|
|
148139
|
+
}
|
|
148140
|
+
}
|
|
148141
|
+
],
|
|
148142
|
+
"name": "TopicBase",
|
|
148143
|
+
"namespace": "aws.notify",
|
|
148144
|
+
"properties": [
|
|
148145
|
+
{
|
|
148146
|
+
"abstract": true,
|
|
148147
|
+
"docs": {
|
|
148148
|
+
"remarks": "Set by subclasses.",
|
|
148149
|
+
"stability": "stable",
|
|
148150
|
+
"summary": "Controls automatic creation of policy objects."
|
|
148151
|
+
},
|
|
148152
|
+
"immutable": true,
|
|
148153
|
+
"locationInModule": {
|
|
148154
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
148155
|
+
"line": 146
|
|
148156
|
+
},
|
|
148157
|
+
"name": "autoCreatePolicy",
|
|
148158
|
+
"protected": true,
|
|
148159
|
+
"type": {
|
|
148160
|
+
"primitive": "boolean"
|
|
148161
|
+
}
|
|
148162
|
+
},
|
|
148163
|
+
{
|
|
148164
|
+
"abstract": true,
|
|
148165
|
+
"docs": {
|
|
148166
|
+
"stability": "stable",
|
|
148167
|
+
"summary": "Enables content-based deduplication for FIFO topics."
|
|
148168
|
+
},
|
|
148169
|
+
"immutable": true,
|
|
148170
|
+
"locationInModule": {
|
|
148171
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
148172
|
+
"line": 139
|
|
148173
|
+
},
|
|
148174
|
+
"name": "contentBasedDeduplication",
|
|
148175
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
148176
|
+
"type": {
|
|
148177
|
+
"primitive": "boolean"
|
|
148178
|
+
}
|
|
148179
|
+
},
|
|
148180
|
+
{
|
|
148181
|
+
"abstract": true,
|
|
148182
|
+
"docs": {
|
|
148183
|
+
"remarks": "If false, this is a standard topic.",
|
|
148184
|
+
"stability": "stable",
|
|
148185
|
+
"summary": "Whether this topic is an Amazon SNS FIFO queue."
|
|
148186
|
+
},
|
|
148187
|
+
"immutable": true,
|
|
148188
|
+
"locationInModule": {
|
|
148189
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
148190
|
+
"line": 137
|
|
148191
|
+
},
|
|
148192
|
+
"name": "fifo",
|
|
148193
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
148194
|
+
"type": {
|
|
148195
|
+
"primitive": "boolean"
|
|
148196
|
+
}
|
|
148197
|
+
},
|
|
148198
|
+
{
|
|
148199
|
+
"docs": {
|
|
148200
|
+
"stability": "stable",
|
|
148201
|
+
"summary": "Outputs to register with the parent Scope or undefined if there are no outputs."
|
|
148202
|
+
},
|
|
148203
|
+
"immutable": true,
|
|
148204
|
+
"locationInModule": {
|
|
148205
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
148206
|
+
"line": 128
|
|
148207
|
+
},
|
|
148208
|
+
"name": "outputs",
|
|
148209
|
+
"overrides": "terraconstructs.TerraConstructBase",
|
|
148210
|
+
"type": {
|
|
148211
|
+
"collection": {
|
|
148212
|
+
"elementtype": {
|
|
148213
|
+
"primitive": "any"
|
|
148214
|
+
},
|
|
148215
|
+
"kind": "map"
|
|
148216
|
+
}
|
|
148217
|
+
}
|
|
148218
|
+
},
|
|
148219
|
+
{
|
|
148220
|
+
"abstract": true,
|
|
148221
|
+
"docs": {
|
|
148222
|
+
"stability": "stable",
|
|
148223
|
+
"summary": "The ARN of the topic."
|
|
148224
|
+
},
|
|
148225
|
+
"immutable": true,
|
|
148226
|
+
"locationInModule": {
|
|
148227
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
148228
|
+
"line": 131
|
|
148229
|
+
},
|
|
148230
|
+
"name": "topicArn",
|
|
148231
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
148232
|
+
"type": {
|
|
148233
|
+
"primitive": "string"
|
|
148234
|
+
}
|
|
148235
|
+
},
|
|
148236
|
+
{
|
|
148237
|
+
"abstract": true,
|
|
148238
|
+
"docs": {
|
|
148239
|
+
"stability": "stable",
|
|
148240
|
+
"summary": "The name of the topic."
|
|
148241
|
+
},
|
|
148242
|
+
"immutable": true,
|
|
148243
|
+
"locationInModule": {
|
|
148244
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
148245
|
+
"line": 133
|
|
148246
|
+
},
|
|
148247
|
+
"name": "topicName",
|
|
148248
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
148249
|
+
"type": {
|
|
148250
|
+
"primitive": "string"
|
|
148251
|
+
}
|
|
148252
|
+
},
|
|
148253
|
+
{
|
|
148254
|
+
"docs": {
|
|
148255
|
+
"stability": "stable",
|
|
148256
|
+
"summary": "strongly typed outputs for the topic."
|
|
148257
|
+
},
|
|
148258
|
+
"immutable": true,
|
|
148259
|
+
"locationInModule": {
|
|
148260
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
148261
|
+
"line": 122
|
|
148262
|
+
},
|
|
148263
|
+
"name": "topicOutputs",
|
|
148264
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
148265
|
+
"type": {
|
|
148266
|
+
"fqn": "terraconstructs.aws.notify.TopicOutputs"
|
|
148267
|
+
}
|
|
148268
|
+
},
|
|
148269
|
+
{
|
|
148270
|
+
"abstract": true,
|
|
148271
|
+
"docs": {
|
|
148272
|
+
"remarks": "This property applies only to server-side encryption.",
|
|
148273
|
+
"stability": "stable",
|
|
148274
|
+
"summary": "A KMS Key, either managed by this CDK app, or imported."
|
|
148275
|
+
},
|
|
148276
|
+
"immutable": true,
|
|
148277
|
+
"locationInModule": {
|
|
148278
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
148279
|
+
"line": 135
|
|
148280
|
+
},
|
|
148281
|
+
"name": "masterKey",
|
|
148282
|
+
"optional": true,
|
|
148283
|
+
"overrides": "terraconstructs.aws.notify.ITopic",
|
|
148284
|
+
"type": {
|
|
148285
|
+
"fqn": "terraconstructs.aws.encryption.IKey"
|
|
148286
|
+
}
|
|
148287
|
+
},
|
|
148288
|
+
{
|
|
148289
|
+
"docs": {
|
|
148290
|
+
"stability": "stable",
|
|
148291
|
+
"summary": "Adds a statement to enforce encryption of data in transit when publishing to the topic."
|
|
148292
|
+
},
|
|
148293
|
+
"locationInModule": {
|
|
148294
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
148295
|
+
"line": 151
|
|
148296
|
+
},
|
|
148297
|
+
"name": "enforceSSL",
|
|
148298
|
+
"optional": true,
|
|
148299
|
+
"protected": true,
|
|
148300
|
+
"type": {
|
|
148301
|
+
"primitive": "boolean"
|
|
148302
|
+
}
|
|
148303
|
+
}
|
|
148304
|
+
],
|
|
148305
|
+
"symbolId": "src/aws/notify/topic-base:TopicBase"
|
|
148306
|
+
},
|
|
148307
|
+
"terraconstructs.aws.notify.TopicOutputs": {
|
|
148308
|
+
"assembly": "terraconstructs",
|
|
148309
|
+
"datatype": true,
|
|
148310
|
+
"docs": {
|
|
148311
|
+
"stability": "stable",
|
|
148312
|
+
"summary": "Outputs for the Subscription construct."
|
|
148313
|
+
},
|
|
148314
|
+
"fqn": "terraconstructs.aws.notify.TopicOutputs",
|
|
148315
|
+
"kind": "interface",
|
|
148316
|
+
"locationInModule": {
|
|
148317
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
148318
|
+
"line": 28
|
|
148319
|
+
},
|
|
148320
|
+
"name": "TopicOutputs",
|
|
148321
|
+
"namespace": "aws.notify",
|
|
148322
|
+
"properties": [
|
|
148323
|
+
{
|
|
148324
|
+
"abstract": true,
|
|
148325
|
+
"docs": {
|
|
148326
|
+
"custom": {
|
|
148327
|
+
"attribute": "true"
|
|
148328
|
+
},
|
|
148329
|
+
"stability": "stable",
|
|
148330
|
+
"summary": "The ARN of the topic."
|
|
148331
|
+
},
|
|
148332
|
+
"immutable": true,
|
|
148333
|
+
"locationInModule": {
|
|
148334
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
148335
|
+
"line": 34
|
|
148336
|
+
},
|
|
148337
|
+
"name": "topicArn",
|
|
148338
|
+
"type": {
|
|
148339
|
+
"primitive": "string"
|
|
148340
|
+
}
|
|
148341
|
+
},
|
|
148342
|
+
{
|
|
148343
|
+
"abstract": true,
|
|
148344
|
+
"docs": {
|
|
148345
|
+
"custom": {
|
|
148346
|
+
"attribute": "true"
|
|
148347
|
+
},
|
|
148348
|
+
"stability": "stable",
|
|
148349
|
+
"summary": "The name of the topic."
|
|
148350
|
+
},
|
|
148351
|
+
"immutable": true,
|
|
148352
|
+
"locationInModule": {
|
|
148353
|
+
"filename": "src/aws/notify/topic-base.ts",
|
|
148354
|
+
"line": 41
|
|
148355
|
+
},
|
|
148356
|
+
"name": "topicName",
|
|
148357
|
+
"type": {
|
|
148358
|
+
"primitive": "string"
|
|
148359
|
+
}
|
|
148360
|
+
}
|
|
148361
|
+
],
|
|
148362
|
+
"symbolId": "src/aws/notify/topic-base:TopicOutputs"
|
|
148363
|
+
},
|
|
148364
|
+
"terraconstructs.aws.notify.TopicPolicy": {
|
|
148365
|
+
"assembly": "terraconstructs",
|
|
148366
|
+
"base": "terraconstructs.aws.AwsConstructBase",
|
|
148367
|
+
"docs": {
|
|
148368
|
+
"custom": {
|
|
148369
|
+
"resource": "aws_sns_topic_policy"
|
|
148370
|
+
},
|
|
148371
|
+
"remarks": "Policies define the operations that are allowed on this resource.\n\nYou almost never need to define this construct directly.\n\nAll AWS resources that support resource policies have a method called\n`addToResourcePolicy()`, which will automatically create a new resource\npolicy if one doesn't exist yet, otherwise it will add to the existing\npolicy.\n\nPrefer to use `addToResourcePolicy()` instead.",
|
|
148372
|
+
"stability": "stable",
|
|
148373
|
+
"summary": "The policy for an SNS Topic."
|
|
148374
|
+
},
|
|
148375
|
+
"fqn": "terraconstructs.aws.notify.TopicPolicy",
|
|
148376
|
+
"initializer": {
|
|
148377
|
+
"docs": {
|
|
148378
|
+
"stability": "stable"
|
|
148379
|
+
},
|
|
148380
|
+
"locationInModule": {
|
|
148381
|
+
"filename": "src/aws/notify/policy.ts",
|
|
148382
|
+
"line": 63
|
|
148383
|
+
},
|
|
148384
|
+
"parameters": [
|
|
148385
|
+
{
|
|
148386
|
+
"name": "scope",
|
|
148387
|
+
"type": {
|
|
148388
|
+
"fqn": "constructs.Construct"
|
|
148389
|
+
}
|
|
148390
|
+
},
|
|
148391
|
+
{
|
|
148392
|
+
"name": "id",
|
|
148393
|
+
"type": {
|
|
148394
|
+
"primitive": "string"
|
|
148395
|
+
}
|
|
148396
|
+
},
|
|
148397
|
+
{
|
|
148398
|
+
"name": "props",
|
|
148399
|
+
"type": {
|
|
148400
|
+
"fqn": "terraconstructs.aws.notify.TopicPolicyProps"
|
|
148401
|
+
}
|
|
148402
|
+
}
|
|
148403
|
+
]
|
|
148404
|
+
},
|
|
148405
|
+
"kind": "class",
|
|
148406
|
+
"locationInModule": {
|
|
148407
|
+
"filename": "src/aws/notify/policy.ts",
|
|
148408
|
+
"line": 50
|
|
148409
|
+
},
|
|
148410
|
+
"methods": [
|
|
148411
|
+
{
|
|
148412
|
+
"docs": {
|
|
148413
|
+
"remarks": "For more information, see https://docs.aws.amazon.com/sns/latest/dg/sns-security-best-practices.html#enforce-encryption-data-in-transit.",
|
|
148414
|
+
"stability": "stable",
|
|
148415
|
+
"summary": "Creates a statement to enforce encryption of data in transit when publishing to the topic."
|
|
148416
|
+
},
|
|
148417
|
+
"locationInModule": {
|
|
148418
|
+
"filename": "src/aws/notify/policy.ts",
|
|
148419
|
+
"line": 100
|
|
148420
|
+
},
|
|
148421
|
+
"name": "createSSLPolicyStatement",
|
|
148422
|
+
"parameters": [
|
|
148423
|
+
{
|
|
148424
|
+
"name": "topicArns",
|
|
148425
|
+
"type": {
|
|
148426
|
+
"collection": {
|
|
148427
|
+
"elementtype": {
|
|
148428
|
+
"primitive": "string"
|
|
148429
|
+
},
|
|
148430
|
+
"kind": "array"
|
|
148431
|
+
}
|
|
148432
|
+
}
|
|
148433
|
+
}
|
|
148434
|
+
],
|
|
148435
|
+
"protected": true,
|
|
148436
|
+
"returns": {
|
|
148437
|
+
"type": {
|
|
148438
|
+
"fqn": "terraconstructs.aws.iam.PolicyStatement"
|
|
148439
|
+
}
|
|
148440
|
+
}
|
|
148441
|
+
}
|
|
148442
|
+
],
|
|
148443
|
+
"name": "TopicPolicy",
|
|
148444
|
+
"namespace": "aws.notify",
|
|
148445
|
+
"properties": [
|
|
148446
|
+
{
|
|
148447
|
+
"docs": {
|
|
148448
|
+
"stability": "stable",
|
|
148449
|
+
"summary": "The IAM policy document associated with this policy."
|
|
148450
|
+
},
|
|
148451
|
+
"immutable": true,
|
|
148452
|
+
"locationInModule": {
|
|
148453
|
+
"filename": "src/aws/notify/policy.ts",
|
|
148454
|
+
"line": 54
|
|
148455
|
+
},
|
|
148456
|
+
"name": "document",
|
|
148457
|
+
"type": {
|
|
148458
|
+
"fqn": "terraconstructs.aws.iam.PolicyDocument"
|
|
148459
|
+
}
|
|
148460
|
+
},
|
|
148461
|
+
{
|
|
148462
|
+
"docs": {
|
|
148463
|
+
"stability": "stable",
|
|
148464
|
+
"summary": "Outputs to register with the parent Scope or undefined if there are no outputs."
|
|
148465
|
+
},
|
|
148466
|
+
"immutable": true,
|
|
148467
|
+
"locationInModule": {
|
|
148468
|
+
"filename": "src/aws/notify/policy.ts",
|
|
148469
|
+
"line": 57
|
|
148470
|
+
},
|
|
148471
|
+
"name": "outputs",
|
|
148472
|
+
"overrides": "terraconstructs.TerraConstructBase",
|
|
148473
|
+
"type": {
|
|
148474
|
+
"collection": {
|
|
148475
|
+
"elementtype": {
|
|
148476
|
+
"primitive": "any"
|
|
148477
|
+
},
|
|
148478
|
+
"kind": "map"
|
|
148479
|
+
}
|
|
148480
|
+
}
|
|
148481
|
+
}
|
|
148482
|
+
],
|
|
148483
|
+
"symbolId": "src/aws/notify/policy:TopicPolicy"
|
|
148484
|
+
},
|
|
148485
|
+
"terraconstructs.aws.notify.TopicPolicyProps": {
|
|
148486
|
+
"assembly": "terraconstructs",
|
|
148487
|
+
"datatype": true,
|
|
148488
|
+
"docs": {
|
|
148489
|
+
"stability": "stable",
|
|
148490
|
+
"summary": "Properties to associate SNS topics with a policy."
|
|
148491
|
+
},
|
|
148492
|
+
"fqn": "terraconstructs.aws.notify.TopicPolicyProps",
|
|
148493
|
+
"interfaces": [
|
|
148494
|
+
"terraconstructs.aws.AwsConstructProps"
|
|
148495
|
+
],
|
|
148496
|
+
"kind": "interface",
|
|
148497
|
+
"locationInModule": {
|
|
148498
|
+
"filename": "src/aws/notify/policy.ts",
|
|
148499
|
+
"line": 12
|
|
148500
|
+
},
|
|
148501
|
+
"name": "TopicPolicyProps",
|
|
148502
|
+
"namespace": "aws.notify",
|
|
148503
|
+
"properties": [
|
|
148504
|
+
{
|
|
148505
|
+
"abstract": true,
|
|
148506
|
+
"docs": {
|
|
148507
|
+
"stability": "stable",
|
|
148508
|
+
"summary": "The set of topics this policy applies to."
|
|
148509
|
+
},
|
|
148510
|
+
"immutable": true,
|
|
148511
|
+
"locationInModule": {
|
|
148512
|
+
"filename": "src/aws/notify/policy.ts",
|
|
148513
|
+
"line": 16
|
|
148514
|
+
},
|
|
148515
|
+
"name": "topics",
|
|
148516
|
+
"type": {
|
|
148517
|
+
"collection": {
|
|
148518
|
+
"elementtype": {
|
|
148519
|
+
"fqn": "terraconstructs.aws.notify.ITopic"
|
|
148520
|
+
},
|
|
148521
|
+
"kind": "array"
|
|
148522
|
+
}
|
|
148523
|
+
}
|
|
148524
|
+
},
|
|
148525
|
+
{
|
|
148526
|
+
"abstract": true,
|
|
148527
|
+
"docs": {
|
|
148528
|
+
"default": "false",
|
|
148529
|
+
"remarks": "For more information, see https://docs.aws.amazon.com/sns/latest/dg/sns-security-best-practices.html#enforce-encryption-data-in-transit.",
|
|
148530
|
+
"stability": "stable",
|
|
148531
|
+
"summary": "Adds a statement to enforce encryption of data in transit when publishing to the topic."
|
|
148532
|
+
},
|
|
148533
|
+
"immutable": true,
|
|
148534
|
+
"locationInModule": {
|
|
148535
|
+
"filename": "src/aws/notify/policy.ts",
|
|
148536
|
+
"line": 31
|
|
148537
|
+
},
|
|
148538
|
+
"name": "enforceSSL",
|
|
148539
|
+
"optional": true,
|
|
148540
|
+
"type": {
|
|
148541
|
+
"primitive": "boolean"
|
|
148542
|
+
}
|
|
148543
|
+
},
|
|
148544
|
+
{
|
|
148545
|
+
"abstract": true,
|
|
148546
|
+
"docs": {
|
|
148547
|
+
"default": "empty policy document",
|
|
148548
|
+
"stability": "stable",
|
|
148549
|
+
"summary": "IAM policy document to apply to topic(s)."
|
|
148550
|
+
},
|
|
148551
|
+
"immutable": true,
|
|
148552
|
+
"locationInModule": {
|
|
148553
|
+
"filename": "src/aws/notify/policy.ts",
|
|
148554
|
+
"line": 22
|
|
148555
|
+
},
|
|
148556
|
+
"name": "policyDocument",
|
|
148557
|
+
"optional": true,
|
|
148558
|
+
"type": {
|
|
148559
|
+
"fqn": "terraconstructs.aws.iam.PolicyDocument"
|
|
148560
|
+
}
|
|
148561
|
+
}
|
|
148562
|
+
],
|
|
148563
|
+
"symbolId": "src/aws/notify/policy:TopicPolicyProps"
|
|
148564
|
+
},
|
|
148565
|
+
"terraconstructs.aws.notify.TopicProps": {
|
|
148566
|
+
"assembly": "terraconstructs",
|
|
148567
|
+
"datatype": true,
|
|
148568
|
+
"docs": {
|
|
148569
|
+
"stability": "stable",
|
|
148570
|
+
"summary": "Properties for a new SNS topic."
|
|
148571
|
+
},
|
|
148572
|
+
"fqn": "terraconstructs.aws.notify.TopicProps",
|
|
148573
|
+
"interfaces": [
|
|
148574
|
+
"terraconstructs.aws.AwsConstructProps"
|
|
148575
|
+
],
|
|
148576
|
+
"kind": "interface",
|
|
148577
|
+
"locationInModule": {
|
|
148578
|
+
"filename": "src/aws/notify/topic.ts",
|
|
148579
|
+
"line": 15
|
|
148580
|
+
},
|
|
148581
|
+
"name": "TopicProps",
|
|
148582
|
+
"namespace": "aws.notify",
|
|
148583
|
+
"properties": [
|
|
148584
|
+
{
|
|
148585
|
+
"abstract": true,
|
|
148586
|
+
"docs": {
|
|
148587
|
+
"default": "None",
|
|
148588
|
+
"stability": "stable",
|
|
148589
|
+
"summary": "Enables content-based deduplication for FIFO topics."
|
|
148590
|
+
},
|
|
148591
|
+
"immutable": true,
|
|
148592
|
+
"locationInModule": {
|
|
148593
|
+
"filename": "src/aws/notify/topic.ts",
|
|
148594
|
+
"line": 49
|
|
148595
|
+
},
|
|
148596
|
+
"name": "contentBasedDeduplication",
|
|
148597
|
+
"optional": true,
|
|
148598
|
+
"type": {
|
|
148599
|
+
"primitive": "boolean"
|
|
148600
|
+
}
|
|
148601
|
+
},
|
|
148602
|
+
{
|
|
148603
|
+
"abstract": true,
|
|
148604
|
+
"docs": {
|
|
148605
|
+
"default": "None",
|
|
148606
|
+
"remarks": "The display name must be maximum 100 characters long, including hyphens (-),\nunderscores (_), spaces, and tabs.",
|
|
148607
|
+
"stability": "stable",
|
|
148608
|
+
"summary": "A developer-defined string that can be used to identify this SNS topic."
|
|
148609
|
+
},
|
|
148610
|
+
"immutable": true,
|
|
148611
|
+
"locationInModule": {
|
|
148612
|
+
"filename": "src/aws/notify/topic.ts",
|
|
148613
|
+
"line": 24
|
|
148614
|
+
},
|
|
148615
|
+
"name": "displayName",
|
|
148616
|
+
"optional": true,
|
|
148617
|
+
"type": {
|
|
148618
|
+
"primitive": "string"
|
|
148619
|
+
}
|
|
148620
|
+
},
|
|
148621
|
+
{
|
|
148622
|
+
"abstract": true,
|
|
148623
|
+
"docs": {
|
|
148624
|
+
"default": "false",
|
|
148625
|
+
"see": "https://docs.aws.amazon.com/sns/latest/dg/sns-security-best-practices.html#enforce-encryption-data-in-transit.",
|
|
148626
|
+
"stability": "stable",
|
|
148627
|
+
"summary": "Adds a statement to enforce encryption of data in transit when publishing to the topic."
|
|
148628
|
+
},
|
|
148629
|
+
"immutable": true,
|
|
148630
|
+
"locationInModule": {
|
|
148631
|
+
"filename": "src/aws/notify/topic.ts",
|
|
148632
|
+
"line": 85
|
|
148633
|
+
},
|
|
148634
|
+
"name": "enforceSSL",
|
|
148635
|
+
"optional": true,
|
|
148636
|
+
"type": {
|
|
148637
|
+
"primitive": "boolean"
|
|
148638
|
+
}
|
|
148639
|
+
},
|
|
148640
|
+
{
|
|
148641
|
+
"abstract": true,
|
|
148642
|
+
"docs": {
|
|
148643
|
+
"default": "None",
|
|
148644
|
+
"stability": "stable",
|
|
148645
|
+
"summary": "Set to true to create a FIFO topic."
|
|
148646
|
+
},
|
|
148647
|
+
"immutable": true,
|
|
148648
|
+
"locationInModule": {
|
|
148649
|
+
"filename": "src/aws/notify/topic.ts",
|
|
148650
|
+
"line": 56
|
|
148651
|
+
},
|
|
148652
|
+
"name": "fifo",
|
|
148653
|
+
"optional": true,
|
|
148654
|
+
"type": {
|
|
148655
|
+
"primitive": "boolean"
|
|
148656
|
+
}
|
|
148657
|
+
},
|
|
148658
|
+
{
|
|
148659
|
+
"abstract": true,
|
|
148660
|
+
"docs": {
|
|
148661
|
+
"default": "None",
|
|
148662
|
+
"see": "https://docs.aws.amazon.com/sns/latest/dg/sns-topic-attributes.html.",
|
|
148663
|
+
"stability": "stable",
|
|
148664
|
+
"summary": "The list of delivery status logging configurations for the topic."
|
|
148665
|
+
},
|
|
148666
|
+
"immutable": true,
|
|
148667
|
+
"locationInModule": {
|
|
148668
|
+
"filename": "src/aws/notify/topic.ts",
|
|
148669
|
+
"line": 65
|
|
148670
|
+
},
|
|
148671
|
+
"name": "loggingConfigs",
|
|
148672
|
+
"optional": true,
|
|
148673
|
+
"type": {
|
|
148674
|
+
"collection": {
|
|
148675
|
+
"elementtype": {
|
|
148676
|
+
"fqn": "terraconstructs.aws.notify.LoggingConfig"
|
|
148677
|
+
},
|
|
148678
|
+
"kind": "array"
|
|
148679
|
+
}
|
|
148680
|
+
}
|
|
148681
|
+
},
|
|
148682
|
+
{
|
|
148683
|
+
"abstract": true,
|
|
148684
|
+
"docs": {
|
|
148685
|
+
"default": "None",
|
|
148686
|
+
"stability": "stable",
|
|
148687
|
+
"summary": "A KMS Key, either managed by this CDK app, or imported."
|
|
148688
|
+
},
|
|
148689
|
+
"immutable": true,
|
|
148690
|
+
"locationInModule": {
|
|
148691
|
+
"filename": "src/aws/notify/topic.ts",
|
|
148692
|
+
"line": 42
|
|
148693
|
+
},
|
|
148694
|
+
"name": "masterKey",
|
|
148695
|
+
"optional": true,
|
|
148696
|
+
"type": {
|
|
148697
|
+
"fqn": "terraconstructs.aws.encryption.IKey"
|
|
148698
|
+
}
|
|
148699
|
+
},
|
|
148700
|
+
{
|
|
148701
|
+
"abstract": true,
|
|
148702
|
+
"docs": {
|
|
148703
|
+
"default": "- do not archive messages",
|
|
148704
|
+
"remarks": "It can only be set for FIFO topics.",
|
|
148705
|
+
"see": "https://docs.aws.amazon.com/sns/latest/dg/fifo-message-archiving-replay.html",
|
|
148706
|
+
"stability": "stable",
|
|
148707
|
+
"summary": "The number of days Amazon SNS retains messages."
|
|
148708
|
+
},
|
|
148709
|
+
"immutable": true,
|
|
148710
|
+
"locationInModule": {
|
|
148711
|
+
"filename": "src/aws/notify/topic.ts",
|
|
148712
|
+
"line": 76
|
|
148713
|
+
},
|
|
148714
|
+
"name": "messageRetentionPeriodInDays",
|
|
148715
|
+
"optional": true,
|
|
148716
|
+
"type": {
|
|
148717
|
+
"primitive": "number"
|
|
148718
|
+
}
|
|
148719
|
+
},
|
|
148720
|
+
{
|
|
148721
|
+
"abstract": true,
|
|
148722
|
+
"docs": {
|
|
148723
|
+
"default": "1",
|
|
148724
|
+
"see": "https://docs.aws.amazon.com/sns/latest/dg/sns-verify-signature-of-message.html.",
|
|
148725
|
+
"stability": "stable",
|
|
148726
|
+
"summary": "The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS."
|
|
148727
|
+
},
|
|
148728
|
+
"immutable": true,
|
|
148729
|
+
"locationInModule": {
|
|
148730
|
+
"filename": "src/aws/notify/topic.ts",
|
|
148731
|
+
"line": 95
|
|
148732
|
+
},
|
|
148733
|
+
"name": "signatureVersion",
|
|
148734
|
+
"optional": true,
|
|
148735
|
+
"type": {
|
|
148736
|
+
"primitive": "string"
|
|
148737
|
+
}
|
|
148738
|
+
},
|
|
148739
|
+
{
|
|
148740
|
+
"abstract": true,
|
|
148741
|
+
"docs": {
|
|
148742
|
+
"default": "Generated name",
|
|
148743
|
+
"remarks": "If you don't specify a name, AWS CloudFormation generates a unique\nphysical ID and uses that ID for the topic name. For more information,\nsee Name Type.",
|
|
148744
|
+
"stability": "stable",
|
|
148745
|
+
"summary": "A name for the topic."
|
|
148746
|
+
},
|
|
148747
|
+
"immutable": true,
|
|
148748
|
+
"locationInModule": {
|
|
148749
|
+
"filename": "src/aws/notify/topic.ts",
|
|
148750
|
+
"line": 35
|
|
148751
|
+
},
|
|
148752
|
+
"name": "topicName",
|
|
148753
|
+
"optional": true,
|
|
148754
|
+
"type": {
|
|
148755
|
+
"primitive": "string"
|
|
148756
|
+
}
|
|
148757
|
+
},
|
|
148758
|
+
{
|
|
148759
|
+
"abstract": true,
|
|
148760
|
+
"docs": {
|
|
148761
|
+
"default": "TracingConfig.PASS_THROUGH",
|
|
148762
|
+
"see": "https://docs.aws.amazon.com/sns/latest/dg/sns-active-tracing.html",
|
|
148763
|
+
"stability": "stable",
|
|
148764
|
+
"summary": "Tracing mode of an Amazon SNS topic."
|
|
148765
|
+
},
|
|
148766
|
+
"immutable": true,
|
|
148767
|
+
"locationInModule": {
|
|
148768
|
+
"filename": "src/aws/notify/topic.ts",
|
|
148769
|
+
"line": 104
|
|
148770
|
+
},
|
|
148771
|
+
"name": "tracingConfig",
|
|
148772
|
+
"optional": true,
|
|
148773
|
+
"type": {
|
|
148774
|
+
"fqn": "terraconstructs.aws.notify.TracingConfig"
|
|
148775
|
+
}
|
|
148776
|
+
}
|
|
148777
|
+
],
|
|
148778
|
+
"symbolId": "src/aws/notify/topic:TopicProps"
|
|
148779
|
+
},
|
|
148780
|
+
"terraconstructs.aws.notify.TopicSubscriptionConfig": {
|
|
148781
|
+
"assembly": "terraconstructs",
|
|
148782
|
+
"datatype": true,
|
|
148783
|
+
"docs": {
|
|
148784
|
+
"stability": "stable",
|
|
148785
|
+
"summary": "Subscription configuration."
|
|
148786
|
+
},
|
|
148787
|
+
"fqn": "terraconstructs.aws.notify.TopicSubscriptionConfig",
|
|
148788
|
+
"interfaces": [
|
|
148789
|
+
"terraconstructs.aws.notify.SubscriptionOptions"
|
|
148790
|
+
],
|
|
148791
|
+
"kind": "interface",
|
|
148792
|
+
"locationInModule": {
|
|
148793
|
+
"filename": "src/aws/notify/subscriber.ts",
|
|
148794
|
+
"line": 10
|
|
148795
|
+
},
|
|
148796
|
+
"name": "TopicSubscriptionConfig",
|
|
148797
|
+
"namespace": "aws.notify",
|
|
148798
|
+
"properties": [
|
|
148799
|
+
{
|
|
148800
|
+
"abstract": true,
|
|
148801
|
+
"docs": {
|
|
148802
|
+
"remarks": "In most\ncases, it is recommended to use the `uniqueId` of the topic you are\nsubscribing to.",
|
|
148803
|
+
"stability": "stable",
|
|
148804
|
+
"summary": "The id of the SNS subscription resource created under `scope`."
|
|
148805
|
+
},
|
|
148806
|
+
"immutable": true,
|
|
148807
|
+
"locationInModule": {
|
|
148808
|
+
"filename": "src/aws/notify/subscriber.ts",
|
|
148809
|
+
"line": 28
|
|
148810
|
+
},
|
|
148811
|
+
"name": "subscriberId",
|
|
148812
|
+
"type": {
|
|
148813
|
+
"primitive": "string"
|
|
148814
|
+
}
|
|
148815
|
+
},
|
|
148816
|
+
{
|
|
148817
|
+
"abstract": true,
|
|
148818
|
+
"docs": {
|
|
148819
|
+
"default": "- use the topic as the scope of the subscription, in which case `subscriberId` must be defined.",
|
|
148820
|
+
"remarks": "Normally you'd\nwant the subscription to be created on the consuming stack because the\ntopic is usually referenced by the consumer's resource policy (e.g. SQS\nqueue policy). Otherwise, it will cause a cyclic reference.\n\nIf this is undefined, the subscription will be created on the topic's stack.",
|
|
148821
|
+
"stability": "stable",
|
|
148822
|
+
"summary": "The scope in which to create the SNS subscription resource."
|
|
148823
|
+
},
|
|
148824
|
+
"immutable": true,
|
|
148825
|
+
"locationInModule": {
|
|
148826
|
+
"filename": "src/aws/notify/subscriber.ts",
|
|
148827
|
+
"line": 21
|
|
148828
|
+
},
|
|
148829
|
+
"name": "subscriberScope",
|
|
148830
|
+
"optional": true,
|
|
148831
|
+
"type": {
|
|
148832
|
+
"fqn": "constructs.Construct"
|
|
148833
|
+
}
|
|
148834
|
+
},
|
|
148835
|
+
{
|
|
148836
|
+
"abstract": true,
|
|
148837
|
+
"docs": {
|
|
148838
|
+
"default": "- empty list",
|
|
148839
|
+
"remarks": "For example for SQS subscription, the subscription needs to have a dependency on the SQS queue policy\nin order for the subscription to successfully deliver messages.",
|
|
148840
|
+
"stability": "stable",
|
|
148841
|
+
"summary": "The resources that need to be created before the subscription can be safely created."
|
|
148842
|
+
},
|
|
148843
|
+
"immutable": true,
|
|
148844
|
+
"locationInModule": {
|
|
148845
|
+
"filename": "src/aws/notify/subscriber.ts",
|
|
148846
|
+
"line": 37
|
|
148847
|
+
},
|
|
148848
|
+
"name": "subscriptionDependency",
|
|
148849
|
+
"optional": true,
|
|
148850
|
+
"type": {
|
|
148851
|
+
"fqn": "constructs.IDependable"
|
|
148852
|
+
}
|
|
148853
|
+
}
|
|
148854
|
+
],
|
|
148855
|
+
"symbolId": "src/aws/notify/subscriber:TopicSubscriptionConfig"
|
|
148856
|
+
},
|
|
148857
|
+
"terraconstructs.aws.notify.TracingConfig": {
|
|
148858
|
+
"assembly": "terraconstructs",
|
|
148859
|
+
"docs": {
|
|
148860
|
+
"stability": "stable",
|
|
148861
|
+
"summary": "The tracing mode of an Amazon SNS topic."
|
|
148862
|
+
},
|
|
148863
|
+
"fqn": "terraconstructs.aws.notify.TracingConfig",
|
|
148864
|
+
"kind": "enum",
|
|
148865
|
+
"locationInModule": {
|
|
148866
|
+
"filename": "src/aws/notify/topic.ts",
|
|
148867
|
+
"line": 205
|
|
148868
|
+
},
|
|
148869
|
+
"members": [
|
|
148870
|
+
{
|
|
148871
|
+
"docs": {
|
|
148872
|
+
"stability": "stable",
|
|
148873
|
+
"summary": "The mode that topic passes trace headers received from the Amazon SNS publisher to its subscription."
|
|
148874
|
+
},
|
|
148875
|
+
"name": "PASS_THROUGH"
|
|
148876
|
+
},
|
|
148877
|
+
{
|
|
148878
|
+
"docs": {
|
|
148879
|
+
"stability": "stable",
|
|
148880
|
+
"summary": "The mode that Amazon SNS vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true."
|
|
148881
|
+
},
|
|
148882
|
+
"name": "ACTIVE"
|
|
148883
|
+
}
|
|
148884
|
+
],
|
|
148885
|
+
"name": "TracingConfig",
|
|
148886
|
+
"namespace": "aws.notify",
|
|
148887
|
+
"symbolId": "src/aws/notify/topic:TracingConfig"
|
|
148888
|
+
},
|
|
144359
148889
|
"terraconstructs.aws.notify.targets.CloudWatchLogGroup": {
|
|
144360
148890
|
"assembly": "terraconstructs",
|
|
144361
148891
|
"docs": {
|
|
@@ -152861,6 +157391,6 @@
|
|
|
152861
157391
|
"symbolId": "src/aws/storage/notification-targets/queue:QueueDestination"
|
|
152862
157392
|
}
|
|
152863
157393
|
},
|
|
152864
|
-
"version": "0.0.
|
|
152865
|
-
"fingerprint": "
|
|
157394
|
+
"version": "0.0.18",
|
|
157395
|
+
"fingerprint": "0+hXOXg+L+4hdacFWylQEirJzVyMROVgmZKC6CTg0P4="
|
|
152866
157396
|
}
|