terraconstructs 0.0.19 → 0.0.21

package/.jsii

@@ -2422,10 +2422,17 @@
       },
       "symbolId": "src/aws/notify/index:"
     },
+    "terraconstructs.aws.notify.subscriptions": {
+      "locationInModule": {
+        "filename": "src/aws/notify/index.ts",
+        "line": 33
+      },
+      "symbolId": "src/aws/notify/subscriptions/index:"
+    },
     "terraconstructs.aws.notify.targets": {
       "locationInModule": {
         "filename": "src/aws/notify/index.ts",
-        "line": 30
+        "line": 31
       },
       "symbolId": "src/aws/notify/targets/index:"
     },
@@ -137579,7 +137586,7 @@
         },
         "locationInModule": {
           "filename": "src/aws/notify/subscription.ts",
-          "line": 560
+          "line": 562
         },
         "parameters": [
           {
@@ -137596,7 +137603,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/aws/notify/subscription.ts",
-        "line": 551
+        "line": 553
       },
       "name": "Filter",
       "namespace": "aws.notify",
@@ -137609,7 +137616,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/aws/notify/subscription.ts",
-            "line": 560
+            "line": 562
           },
           "name": "filterDoc",
           "type": {
@@ -137624,7 +137631,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/aws/notify/subscription.ts",
-            "line": 555
+            "line": 557
           },
           "name": "type",
           "overrides": "terraconstructs.aws.notify.FilterOrPolicy",
@@ -137651,7 +137658,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/aws/notify/subscription.ts",
-        "line": 513
+        "line": 515
       },
       "methods": [
         {
@@ -137661,7 +137668,7 @@
           },
           "locationInModule": {
             "filename": "src/aws/notify/subscription.ts",
-            "line": 517
+            "line": 519
           },
           "name": "filter",
           "parameters": [
@@ -137686,7 +137693,7 @@
           },
           "locationInModule": {
             "filename": "src/aws/notify/subscription.ts",
-            "line": 524
+            "line": 526
           },
           "name": "policy",
           "parameters": [
@@ -137716,7 +137723,7 @@
           },
           "locationInModule": {
             "filename": "src/aws/notify/subscription.ts",
-            "line": 543
+            "line": 545
           },
           "name": "isFilter",
           "returns": {
@@ -137732,7 +137739,7 @@
           },
           "locationInModule": {
             "filename": "src/aws/notify/subscription.ts",
-            "line": 536
+            "line": 538
           },
           "name": "isPolicy",
           "returns": {
@@ -137754,7 +137761,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/aws/notify/subscription.ts",
-            "line": 531
+            "line": 533
           },
           "name": "type",
           "type": {
@@ -137774,7 +137781,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/aws/notify/subscription.ts",
-        "line": 499
+        "line": 501
       },
       "members": [
         {
@@ -142360,7 +142367,7 @@
         },
         "locationInModule": {
           "filename": "src/aws/notify/subscription.ts",
-          "line": 577
+          "line": 579
         },
         "parameters": [
           {
@@ -142382,7 +142389,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/aws/notify/subscription.ts",
-        "line": 568
+        "line": 570
       },
       "name": "Policy",
       "namespace": "aws.notify",
@@ -142395,7 +142402,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/aws/notify/subscription.ts",
-            "line": 578
+            "line": 580
           },
           "name": "policyDoc",
           "type": {
@@ -142415,7 +142422,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/aws/notify/subscription.ts",
-            "line": 572
+            "line": 574
           },
           "name": "type",
           "overrides": "terraconstructs.aws.notify.FilterOrPolicy",
@@ -147187,7 +147194,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/aws/notify/subscription.ts",
-        "line": 416
+        "line": 418
       },
       "members": [
         {
@@ -148886,6 +148893,642 @@
       "namespace": "aws.notify",
       "symbolId": "src/aws/notify/topic:TracingConfig"
     },
+    "terraconstructs.aws.notify.subscriptions.EmailSubscription": {
+      "assembly": "terraconstructs",
+      "docs": {
+        "remarks": "Email subscriptions require confirmation.",
+        "stability": "stable",
+        "summary": "Use an email address as a subscription target."
+      },
+      "fqn": "terraconstructs.aws.notify.subscriptions.EmailSubscription",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/aws/notify/subscriptions/email.ts",
+          "line": 25
+        },
+        "parameters": [
+          {
+            "name": "emailAddress",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "optional": true,
+            "type": {
+              "fqn": "terraconstructs.aws.notify.subscriptions.EmailSubscriptionProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "terraconstructs.aws.notify.ITopicSubscription"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/aws/notify/subscriptions/email.ts",
+        "line": 24
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Returns a configuration for an email address to subscribe to an SNS topic."
+          },
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/email.ts",
+            "line": 33
+          },
+          "name": "bind",
+          "overrides": "terraconstructs.aws.notify.ITopicSubscription",
+          "parameters": [
+            {
+              "name": "_topic",
+              "type": {
+                "fqn": "terraconstructs.aws.notify.ITopic"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "terraconstructs.aws.notify.TopicSubscriptionConfig"
+            }
+          }
+        }
+      ],
+      "name": "EmailSubscription",
+      "namespace": "aws.notify.subscriptions",
+      "symbolId": "src/aws/notify/subscriptions/email:EmailSubscription"
+    },
+    "terraconstructs.aws.notify.subscriptions.EmailSubscriptionProps": {
+      "assembly": "terraconstructs",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Options for email subscriptions."
+      },
+      "fqn": "terraconstructs.aws.notify.subscriptions.EmailSubscriptionProps",
+      "interfaces": [
+        "terraconstructs.aws.notify.subscriptions.SubscriptionProps"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/aws/notify/subscriptions/email.ts",
+        "line": 9
+      },
+      "name": "EmailSubscriptionProps",
+      "namespace": "aws.notify.subscriptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false (Message text)",
+            "stability": "stable",
+            "summary": "Indicates if the full notification JSON should be sent to the email address or just the message text."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/email.ts",
+            "line": 16
+          },
+          "name": "json",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/aws/notify/subscriptions/email:EmailSubscriptionProps"
+    },
+    "terraconstructs.aws.notify.subscriptions.LambdaSubscription": {
+      "assembly": "terraconstructs",
+      "docs": {
+        "stability": "stable",
+        "summary": "Use a Lambda function as a subscription target."
+      },
+      "fqn": "terraconstructs.aws.notify.subscriptions.LambdaSubscription",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/aws/notify/subscriptions/lambda.ts",
+          "line": 20
+        },
+        "parameters": [
+          {
+            "name": "fn",
+            "type": {
+              "fqn": "terraconstructs.aws.compute.IFunction"
+            }
+          },
+          {
+            "name": "props",
+            "optional": true,
+            "type": {
+              "fqn": "terraconstructs.aws.notify.subscriptions.LambdaSubscriptionProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "terraconstructs.aws.notify.ITopicSubscription"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/aws/notify/subscriptions/lambda.ts",
+        "line": 19
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Returns a configuration for a Lambda function to subscribe to an SNS topic."
+          },
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/lambda.ts",
+            "line": 28
+          },
+          "name": "bind",
+          "overrides": "terraconstructs.aws.notify.ITopicSubscription",
+          "parameters": [
+            {
+              "name": "topic",
+              "type": {
+                "fqn": "terraconstructs.aws.notify.ITopic"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "terraconstructs.aws.notify.TopicSubscriptionConfig"
+            }
+          }
+        }
+      ],
+      "name": "LambdaSubscription",
+      "namespace": "aws.notify.subscriptions",
+      "symbolId": "src/aws/notify/subscriptions/lambda:LambdaSubscription"
+    },
+    "terraconstructs.aws.notify.subscriptions.LambdaSubscriptionProps": {
+      "assembly": "terraconstructs",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Properties for a Lambda subscription."
+      },
+      "fqn": "terraconstructs.aws.notify.subscriptions.LambdaSubscriptionProps",
+      "interfaces": [
+        "terraconstructs.aws.notify.subscriptions.SubscriptionProps"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/aws/notify/subscriptions/lambda.ts",
+        "line": 15
+      },
+      "name": "LambdaSubscriptionProps",
+      "namespace": "aws.notify.subscriptions",
+      "symbolId": "src/aws/notify/subscriptions/lambda:LambdaSubscriptionProps"
+    },
+    "terraconstructs.aws.notify.subscriptions.SmsSubscription": {
+      "assembly": "terraconstructs",
+      "docs": {
+        "stability": "stable",
+        "summary": "Use an sms address as a subscription target."
+      },
+      "fqn": "terraconstructs.aws.notify.subscriptions.SmsSubscription",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/aws/notify/subscriptions/sms.ts",
+          "line": 15
+        },
+        "parameters": [
+          {
+            "name": "phoneNumber",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "optional": true,
+            "type": {
+              "fqn": "terraconstructs.aws.notify.subscriptions.SmsSubscriptionProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "terraconstructs.aws.notify.ITopicSubscription"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/aws/notify/subscriptions/sms.ts",
+        "line": 14
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Returns a configuration used to subscribe to an SNS topic."
+          },
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/sms.ts",
+            "line": 20
+          },
+          "name": "bind",
+          "overrides": "terraconstructs.aws.notify.ITopicSubscription",
+          "parameters": [
+            {
+              "name": "_topic",
+              "type": {
+                "fqn": "terraconstructs.aws.notify.ITopic"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "terraconstructs.aws.notify.TopicSubscriptionConfig"
+            }
+          }
+        }
+      ],
+      "name": "SmsSubscription",
+      "namespace": "aws.notify.subscriptions",
+      "symbolId": "src/aws/notify/subscriptions/sms:SmsSubscription"
+    },
+    "terraconstructs.aws.notify.subscriptions.SmsSubscriptionProps": {
+      "assembly": "terraconstructs",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Options for SMS subscriptions."
+      },
+      "fqn": "terraconstructs.aws.notify.subscriptions.SmsSubscriptionProps",
+      "interfaces": [
+        "terraconstructs.aws.notify.subscriptions.SubscriptionProps"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/aws/notify/subscriptions/sms.ts",
+        "line": 9
+      },
+      "name": "SmsSubscriptionProps",
+      "namespace": "aws.notify.subscriptions",
+      "symbolId": "src/aws/notify/subscriptions/sms:SmsSubscriptionProps"
+    },
+    "terraconstructs.aws.notify.subscriptions.SqsSubscription": {
+      "assembly": "terraconstructs",
+      "docs": {
+        "stability": "stable",
+        "summary": "Use an SQS queue as a subscription target."
+      },
+      "fqn": "terraconstructs.aws.notify.subscriptions.SqsSubscription",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/aws/notify/subscriptions/sqs.ts",
+          "line": 30
+        },
+        "parameters": [
+          {
+            "name": "queue",
+            "type": {
+              "fqn": "terraconstructs.aws.notify.IQueue"
+            }
+          },
+          {
+            "name": "props",
+            "optional": true,
+            "type": {
+              "fqn": "terraconstructs.aws.notify.subscriptions.SqsSubscriptionProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "terraconstructs.aws.notify.ITopicSubscription"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/aws/notify/subscriptions/sqs.ts",
+        "line": 29
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Returns a configuration for an SQS queue to subscribe to an SNS topic."
+          },
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/sqs.ts",
+            "line": 38
+          },
+          "name": "bind",
+          "overrides": "terraconstructs.aws.notify.ITopicSubscription",
+          "parameters": [
+            {
+              "name": "topic",
+              "type": {
+                "fqn": "terraconstructs.aws.notify.ITopic"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "terraconstructs.aws.notify.TopicSubscriptionConfig"
+            }
+          }
+        }
+      ],
+      "name": "SqsSubscription",
+      "namespace": "aws.notify.subscriptions",
+      "symbolId": "src/aws/notify/subscriptions/sqs:SqsSubscription"
+    },
+    "terraconstructs.aws.notify.subscriptions.SqsSubscriptionProps": {
+      "assembly": "terraconstructs",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Properties for an SQS subscription."
+      },
+      "fqn": "terraconstructs.aws.notify.subscriptions.SqsSubscriptionProps",
+      "interfaces": [
+        "terraconstructs.aws.notify.subscriptions.SubscriptionProps"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/aws/notify/subscriptions/sqs.ts",
+        "line": 15
+      },
+      "name": "SqsSubscriptionProps",
+      "namespace": "aws.notify.subscriptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "remarks": "If false, the message will be wrapped in an SNS envelope.",
+            "stability": "stable",
+            "summary": "The message to the queue is the same as it was sent to the topic."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/sqs.ts",
+            "line": 23
+          },
+          "name": "rawMessageDelivery",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/aws/notify/subscriptions/sqs:SqsSubscriptionProps"
+    },
+    "terraconstructs.aws.notify.subscriptions.SubscriptionProps": {
+      "assembly": "terraconstructs",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Options to subscribing to an SNS topic."
+      },
+      "fqn": "terraconstructs.aws.notify.subscriptions.SubscriptionProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/aws/notify/subscriptions/subscription.ts",
+        "line": 9
+      },
+      "name": "SubscriptionProps",
+      "namespace": "aws.notify.subscriptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- No dead letter queue enabled.",
+            "remarks": "If not passed no dead letter queue is enabled.",
+            "stability": "stable",
+            "summary": "Queue to be used as dead letter queue."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/subscription.ts",
+            "line": 31
+          },
+          "name": "deadLetterQueue",
+          "optional": true,
+          "type": {
+            "fqn": "terraconstructs.aws.notify.IQueue"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- all messages are delivered",
+            "stability": "stable",
+            "summary": "The filter policy."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/subscription.ts",
+            "line": 15
+          },
+          "name": "filterPolicy",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "terraconstructs.aws.notify.SubscriptionFilter"
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- all messages are delivered",
+            "remarks": "To apply a filter policy to the message attributes, use `filterPolicy`. A maximum of one of `filterPolicyWithMessageBody` and `filterPolicy` may be used.",
+            "stability": "stable",
+            "summary": "The filter policy that is applied on the message body."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/subscription.ts",
+            "line": 22
+          },
+          "name": "filterPolicyWithMessageBody",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "terraconstructs.aws.notify.FilterOrPolicy"
+              },
+              "kind": "map"
+            }
+          }
+        }
+      ],
+      "symbolId": "src/aws/notify/subscriptions/subscription:SubscriptionProps"
+    },
+    "terraconstructs.aws.notify.subscriptions.UrlSubscription": {
+      "assembly": "terraconstructs",
+      "docs": {
+        "remarks": "The message will be POSTed to the given URL.",
+        "see": "https://docs.aws.amazon.com/sns/latest/dg/sns-http-https-endpoint-as-subscriber.html",
+        "stability": "stable",
+        "summary": "Use a URL as a subscription target."
+      },
+      "fqn": "terraconstructs.aws.notify.subscriptions.UrlSubscription",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/aws/notify/subscriptions/url.ts",
+          "line": 46
+        },
+        "parameters": [
+          {
+            "name": "url",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "optional": true,
+            "type": {
+              "fqn": "terraconstructs.aws.notify.subscriptions.UrlSubscriptionProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "terraconstructs.aws.notify.ITopicSubscription"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/aws/notify/subscriptions/url.ts",
+        "line": 42
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Returns a configuration for a URL to subscribe to an SNS topic."
+          },
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/url.ts",
+            "line": 75
+          },
+          "name": "bind",
+          "overrides": "terraconstructs.aws.notify.ITopicSubscription",
+          "parameters": [
+            {
+              "name": "_topic",
+              "type": {
+                "fqn": "terraconstructs.aws.notify.ITopic"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "terraconstructs.aws.notify.TopicSubscriptionConfig"
+            }
+          }
+        }
+      ],
+      "name": "UrlSubscription",
+      "namespace": "aws.notify.subscriptions",
+      "symbolId": "src/aws/notify/subscriptions/url:UrlSubscription"
+    },
+    "terraconstructs.aws.notify.subscriptions.UrlSubscriptionProps": {
+      "assembly": "terraconstructs",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Options for URL subscriptions."
+      },
+      "fqn": "terraconstructs.aws.notify.subscriptions.UrlSubscriptionProps",
+      "interfaces": [
+        "terraconstructs.aws.notify.subscriptions.SubscriptionProps"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/aws/notify/subscriptions/url.ts",
+        "line": 10
+      },
+      "name": "UrlSubscriptionProps",
+      "namespace": "aws.notify.subscriptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- if the initial delivery of the message fails, three retries with a delay between failed attempts set at 20 seconds",
+            "stability": "stable",
+            "summary": "The delivery policy."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/url.ts",
+            "line": 32
+          },
+          "name": "deliveryPolicy",
+          "optional": true,
+          "type": {
+            "fqn": "terraconstructs.aws.notify.DeliveryPolicy"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Protocol is derived from url",
+            "stability": "stable",
+            "summary": "The subscription's protocol."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/url.ts",
+            "line": 25
+          },
+          "name": "protocol",
+          "optional": true,
+          "type": {
+            "fqn": "terraconstructs.aws.notify.SubscriptionProtocol"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "remarks": "If false, the message will be wrapped in an SNS envelope.",
+            "stability": "stable",
+            "summary": "The message to the queue is the same as it was sent to the topic."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/aws/notify/subscriptions/url.ts",
+            "line": 18
+          },
+          "name": "rawMessageDelivery",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/aws/notify/subscriptions/url:UrlSubscriptionProps"
+    },
     "terraconstructs.aws.notify.targets.CloudWatchLogGroup": {
       "assembly": "terraconstructs",
       "docs": {
@@ -157391,6 +158034,6 @@
       "symbolId": "src/aws/storage/notification-targets/queue:QueueDestination"
     }
   },
-  "version": "0.0.19",
-  "fingerprint": "n/TuADNOdqNXm2MVjgf6/s3Jph3pQTM69Q7wP/42gUE="
+  "version": "0.0.21",
+  "fingerprint": "6a0Q9ma6FE/owwvIppqg/IXDucaRseJzGN5cufi1CXg="
 }