cloudstructs 0.6.7 → 0.6.10

package/.gitattributes

@@ -23,6 +23,8 @@
 /src/slack-app/provider-function.ts linguist-generated
 /src/slack-events/events-function.ts linguist-generated
 /src/slack-textract/detect-function.ts linguist-generated
+/src/ssl-server-test/analyze-function.ts linguist-generated
+/src/ssl-server-test/extract-grade-function.ts linguist-generated
 /src/static-website/origin-request-function.ts linguist-generated
 /src/toolkit-cleaner/clean-images-function.ts linguist-generated
 /src/toolkit-cleaner/clean-objects-function.ts linguist-generated

package/.jsii

@@ -2859,7 +2859,7 @@
   },
   "name": "cloudstructs",
   "readme": {
-    "markdown": "# cloudstructs\n\nHigh-level constructs for AWS CDK\n\n## Installation\n\n`npm install cloudstructs` or `yarn add cloudstructs`\n\nVersion >= 0.2.0 requires AWS CDK v2.\n\n## Constructs\n\n* [`CodeCommitMirror`](src/codecommit-mirror) Mirror a repository to AWS CodeCommit on schedule\n\n* [`EcsServiceRoller`](src/ecs-service-roller) Roll your ECS service tasks on schedule or with\n  a rule\n\n* [`EmailReceiver`](src/email-receiver) Receive emails through SES, save them to S3\n  and invoke a Lambda function\n\n* [`SlackApp`](src/slack-app) Deploy Slack apps from manifests\n\n* [`SlackEvents`](src/slack-events) Send Slack events to Amazon EventBridge\n\n* [`SlackTextract`](src/slack-textract) Extract text from images posted to Slack\n  using Amazon Textract. The extracted text is posted in a thread under the image\n  and gets indexed!\n\n* [`StateMachineCustomResourceProvider`](src/state-machine-cr-provider) Implement custom\n  resources with AWS Step Functions state machines\n\n* [`StaticWebsite`](src/static-website) A CloudFront static website hosted on S3 with\n  HTTPS redirect, SPA redirect, HTTP security headers and backend configuration saved\n  to the bucket.\n\n* [`ToolkitCleaner`](src/toolkit-cleaner) Clean unused S3 and ECR assets from your CDK\n  Toolkit.\n\n* [`UrlShortener`](src/url-shortener) Deploy an URL shortener API\n"
+    "markdown": "# cloudstructs\n\nHigh-level constructs for AWS CDK\n\n## Installation\n\n`npm install cloudstructs` or `yarn add cloudstructs`\n\nVersion >= 0.2.0 requires AWS CDK v2.\n\n## Constructs\n\n* [`CodeCommitMirror`](src/codecommit-mirror) Mirror a repository to AWS CodeCommit on schedule\n\n* [`EcsServiceRoller`](src/ecs-service-roller) Roll your ECS service tasks on schedule or with\n  a rule\n\n* [`EmailReceiver`](src/email-receiver) Receive emails through SES, save them to S3\n  and invoke a Lambda function\n\n* [`SlackApp`](src/slack-app) Deploy Slack apps from manifests\n\n* [`SlackEvents`](src/slack-events) Send Slack events to Amazon EventBridge\n\n* [`SlackTextract`](src/slack-textract) Extract text from images posted to Slack\n  using Amazon Textract. The extracted text is posted in a thread under the image\n  and gets indexed!\n\n* [`SslServerTest`](src/ssl-server-test) Test a server/host for SSL/TLS on schedule and\n  get notified when the overall rating is not satisfactory. [Powered by Qualys SSL Labs](https://www.ssllabs.com/).\n\n* [`StateMachineCustomResourceProvider`](src/state-machine-cr-provider) Implement custom\n  resources with AWS Step Functions state machines\n\n* [`StaticWebsite`](src/static-website) A CloudFront static website hosted on S3 with\n  HTTPS redirect, SPA redirect, HTTP security headers and backend configuration saved\n  to the bucket.\n\n* [`ToolkitCleaner`](src/toolkit-cleaner) Clean unused S3 and ECR assets from your CDK\n  Toolkit.\n\n* [`UrlShortener`](src/url-shortener) Deploy an URL shortener API\n"
   },
   "repository": {
     "type": "git",
@@ -5495,6 +5495,222 @@
       ],
       "symbolId": "src/slack-app/manifest:SlackkAppManifestBotUser"
     },
+    "cloudstructs.SslServerTest": {
+      "assembly": "cloudstructs",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "stable",
+        "summary": "Perform SSL server test for a hostname."
+      },
+      "fqn": "cloudstructs.SslServerTest",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/ssl-server-test/index.ts",
+          "line": 71
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "cloudstructs.SslServerTestProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/ssl-server-test/index.ts",
+        "line": 64
+      },
+      "name": "SslServerTest",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "The topic to which the SSL test results are sent when the grade is below the minimum grade."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ssl-server-test/index.ts",
+            "line": 69
+          },
+          "name": "alarmTopic",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_sns.ITopic"
+          }
+        }
+      ],
+      "symbolId": "src/ssl-server-test/index:SslServerTest"
+    },
+    "cloudstructs.SslServerTestGrade": {
+      "assembly": "cloudstructs",
+      "docs": {
+        "stability": "stable",
+        "summary": "SSL Server test grade."
+      },
+      "fqn": "cloudstructs.SslServerTestGrade",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/ssl-server-test/index.ts",
+        "line": 50
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "A_PLUS"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "A"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "A_MINUS"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "B"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "C"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "D"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "E"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "F"
+        }
+      ],
+      "name": "SslServerTestGrade",
+      "symbolId": "src/ssl-server-test/index:SslServerTestGrade"
+    },
+    "cloudstructs.SslServerTestProps": {
+      "assembly": "cloudstructs",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Properties for a SslServerTest."
+      },
+      "fqn": "cloudstructs.SslServerTestProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/ssl-server-test/index.ts",
+        "line": 15
+      },
+      "name": "SslServerTestProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The hostname to test."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ssl-server-test/index.ts",
+            "line": 19
+          },
+          "name": "host",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- a new topic is created",
+            "stability": "stable",
+            "summary": "The topic to which the results must be sent when the grade is below the minimum grade."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ssl-server-test/index.ts",
+            "line": 37
+          },
+          "name": "alarmTopic",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_sns.ITopic"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "SslServerTestGrade.A_PLUS",
+            "remarks": "Used to send the results to an alarm SNS topic.",
+            "stability": "stable",
+            "summary": "Minimum grade for the test. The grade is calculated using the worst grade of all endpoints."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ssl-server-test/index.ts",
+            "line": 29
+          },
+          "name": "minimumGrade",
+          "optional": true,
+          "type": {
+            "fqn": "cloudstructs.SslServerTestGrade"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- every day",
+            "stability": "stable",
+            "summary": "The schedule for the test."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ssl-server-test/index.ts",
+            "line": 44
+          },
+          "name": "schedule",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_events.Schedule"
+          }
+        }
+      ],
+      "symbolId": "src/ssl-server-test/index:SslServerTestProps"
+    },
     "cloudstructs.StateMachineCustomResourceProvider": {
       "assembly": "cloudstructs",
       "base": "constructs.Construct",
@@ -6175,6 +6391,6 @@
       "symbolId": "src/url-shortener/index:UrlShortenerProps"
     }
   },
-  "version": "0.6.7",
-  "fingerprint": "LaofZFVTWt/2ZJcZBYrjMOHzz6FgHfOJt1rweR3w0Co="
+  "version": "0.6.10",
+  "fingerprint": "lPjX6hEDBFR7HPFMaBdi6fD3DijolakEY6/M0iFnmAI="
 }

package/API.md

@@ -16,6 +16,7 @@ Name|Description
 [SlackAppManifestDefinition](#cloudstructs-slackappmanifestdefinition)|A Slack app manifest definition.
 [SlackEvents](#cloudstructs-slackevents)|Send Slack events to Amazon EventBridge.
 [SlackTextract](#cloudstructs-slacktextract)|Extract text from images posted to Slack using Amazon Textract.
+[SslServerTest](#cloudstructs-sslservertest)|Perform SSL server test for a hostname.
 [StateMachineCustomResourceProvider](#cloudstructs-statemachinecustomresourceprovider)|A state machine custom resource provider.
 [StaticWebsite](#cloudstructs-staticwebsite)|A CloudFront static website hosted on S3.
 [ToolkitCleaner](#cloudstructs-toolkitcleaner)|Clean unused S3 and ECR assets from your CDK Toolkit.
@@ -43,6 +44,7 @@ Name|Description
 [SlackEventsProps](#cloudstructs-slackeventsprops)|Properties for a SlackEvents.
 [SlackTextractProps](#cloudstructs-slacktextractprops)|Properties for a SlackTextract.
 [SlackkAppManifestBotUser](#cloudstructs-slackkappmanifestbotuser)|Bot user configuration.
+[SslServerTestProps](#cloudstructs-sslservertestprops)|Properties for a SslServerTest.
 [StateMachineCustomResourceProviderProps](#cloudstructs-statemachinecustomresourceproviderprops)|Properties for a StateMachineCustomResourceProvider.
 [StaticWebsiteProps](#cloudstructs-staticwebsiteprops)|Properties for a StaticWebsite.
 [ToolkitCleanerProps](#cloudstructs-toolkitcleanerprops)|Properties for a ToolkitCleaner.
@@ -61,6 +63,7 @@ Name|Description
 Name|Description
 ----|-----------
 [SlackAppManifestShortcutType](#cloudstructs-slackappmanifestshortcuttype)|Type of shortcuts.
+[SslServerTestGrade](#cloudstructs-sslservertestgrade)|SSL Server test grade.
 
 
 
@@ -557,6 +560,41 @@ new SlackTextract(scope: Construct, id: string, props: SlackTextractProps)
 
 
 
+## class SslServerTest  <a id="cloudstructs-sslservertest"></a>
+
+Perform SSL server test for a hostname.
+
+__Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
+__Extends__: [Construct](#constructs-construct)
+
+### Initializer
+
+
+
+
+```ts
+new SslServerTest(scope: Construct, id: string, props: SslServerTestProps)
+```
+
+* **scope** (<code>[Construct](#constructs-construct)</code>)  *No description*
+* **id** (<code>string</code>)  *No description*
+* **props** (<code>[SslServerTestProps](#cloudstructs-sslservertestprops)</code>)  *No description*
+  * **host** (<code>string</code>)  The hostname to test. 
+  * **alarmTopic** (<code>[aws_sns.ITopic](#aws-cdk-lib-aws-sns-itopic)</code>)  The topic to which the results must be sent when the grade is below the minimum grade. __*Default*__: a new topic is created
+  * **minimumGrade** (<code>[SslServerTestGrade](#cloudstructs-sslservertestgrade)</code>)  Minimum grade for the test. The grade is calculated using the worst grade of all endpoints. __*Default*__: SslServerTestGrade.A_PLUS
+  * **schedule** (<code>[aws_events.Schedule](#aws-cdk-lib-aws-events-schedule)</code>)  The schedule for the test. __*Default*__: every day
+
+
+
+### Properties
+
+
+Name | Type | Description 
+-----|------|-------------
+**alarmTopic** | <code>[aws_sns.ITopic](#aws-cdk-lib-aws-sns-itopic)</code> | The topic to which the SSL test results are sent when the grade is below the minimum grade.
+
+
+
 ## class StateMachineCustomResourceProvider  <a id="cloudstructs-statemachinecustomresourceprovider"></a>
 
 A state machine custom resource provider.
@@ -983,6 +1021,22 @@ Name | Type | Description
 
 
 
+## struct SslServerTestProps  <a id="cloudstructs-sslservertestprops"></a>
+
+
+Properties for a SslServerTest.
+
+
+
+Name | Type | Description 
+-----|------|-------------
+**host** | <code>string</code> | The hostname to test.
+**alarmTopic**? | <code>[aws_sns.ITopic](#aws-cdk-lib-aws-sns-itopic)</code> | The topic to which the results must be sent when the grade is below the minimum grade.<br/>__*Default*__: a new topic is created
+**minimumGrade**? | <code>[SslServerTestGrade](#cloudstructs-sslservertestgrade)</code> | Minimum grade for the test. The grade is calculated using the worst grade of all endpoints.<br/>__*Default*__: SslServerTestGrade.A_PLUS
+**schedule**? | <code>[aws_events.Schedule](#aws-cdk-lib-aws-events-schedule)</code> | The schedule for the test.<br/>__*Default*__: every day
+
+
+
 ## struct StateMachineCustomResourceProviderProps  <a id="cloudstructs-statemachinecustomresourceproviderprops"></a>
 
 
@@ -1059,3 +1113,19 @@ Name | Description
 **GLOBAL** |Global shortcuts are available to users via the shortcuts button in the composer, and when using search in Slack.
 
 
+## enum SslServerTestGrade  <a id="cloudstructs-sslservertestgrade"></a>
+
+SSL Server test grade.
+
+Name | Description
+-----|-----
+**A_PLUS** |
+**A** |
+**A_MINUS** |
+**B** |
+**C** |
+**D** |
+**E** |
+**F** |
+
+

package/README.md

@@ -26,6 +26,9 @@ Version >= 0.2.0 requires AWS CDK v2.
   using Amazon Textract. The extracted text is posted in a thread under the image
   and gets indexed!
 
+* [`SslServerTest`](src/ssl-server-test) Test a server/host for SSL/TLS on schedule and
+  get notified when the overall rating is not satisfactory. [Powered by Qualys SSL Labs](https://www.ssllabs.com/).
+
 * [`StateMachineCustomResourceProvider`](src/state-machine-cr-provider) Implement custom
   resources with AWS Step Functions state machines