Categorygithub.com/jogold/cloudstructs-go/cloudstructs
modulepackage
0.9.24
Repository: https://github.com/jogold/cloudstructs-go.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
19
Dependents
0
Files
3.6k SLOC

# README

cloudstructs

High-level constructs for AWS CDK

Installation

npm install cloudstructs or yarn add cloudstructs

Version >= 0.2.0 requires AWS CDK v2.

Constructs

  • CodeCommitMirror Mirror a repository to AWS CodeCommit on schedule
  • EcsServiceRoller Roll your ECS service tasks on schedule or with a rule
  • EmailReceiver Receive emails through SES, save them to S3 and invoke a Lambda function
  • MjmlTemplate SES email template from MJML
  • SlackApp Deploy Slack apps from manifests
  • SlackEvents Send Slack events to Amazon EventBridge
  • SlackTextract Extract text from images posted to Slack using Amazon Textract. The extracted text is posted in a thread under the image and gets indexed!
  • SslServerTest Test a server/host for SSL/TLS on schedule and get notified when the overall rating is not satisfactory. Powered by Qualys SSL Labs.
  • StateMachineCustomResourceProvider Implement custom resources with AWS Step Functions state machines
  • StaticWebsite A CloudFront static website hosted on S3 with HTTPS redirect, SPA redirect, HTTP security headers and backend configuration saved to the bucket.
  • ToolkitCleaner Clean unused S3 and ECR assets from your CDK Toolkit.
  • UrlShortener Deploy an URL shortener API

# Packages

Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

# Functions

Checks if `x` is a construct.
Public GitHub repository.
Private repository with HTTPS clone URL stored in a AWS Secrets Manager secret or a AWS Systems Manager secure string parameter.
Checks if `x` is a construct.
Checks if `x` is a construct.
Checks if `x` is a construct.
Checks if `x` is a construct.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: use `SamlPrincipal` from `aws-cdk-lib/aws-iam`.
Deprecated: use `SamlPrincipal` from `aws-cdk-lib/aws-iam`.
Deprecated: use `SamlProvider` from `aws-cdk-lib/aws-iam`.
Deprecated: use `SamlProvider` from `aws-cdk-lib/aws-iam`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Rule that should trigger a roll.
Schedule that should trigger a roll.
Checks if `x` is a construct.
Checks if `x` is a construct.
Creates a Slack app manifest from a file containg a JSON app manifest.
Creates a Slack app manifest by specifying properties.
Create a Slack app manifest from a JSON app manifest encoded as a string.
Checks if `x` is a construct.
Checks if `x` is a construct.
Checks if `x` is a construct.
Checks if `x` is a construct.
No description provided by the author
Checks if `x` is a construct.
No description provided by the author
Checks if `x` is a construct.
Checks if `x` is a construct.

# Constants

Relaxed alignment mode.
Strict alignment mode.
Do not apply any special handling to messages that fail DMARC compliance.
Quarantine messages that fail DMARC compliance.
Reject messages that fail DMARC compliance.
Global shortcuts are available to users via the shortcuts button in the composer, and when using search in Slack.
Message shortcuts are shown to users in the context menus of messages within Slack.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Properties for a CodeCommitMirror.
Properties for a DmarcReporter.
Properties for a EcsServiceRoller.
Properties for an EmailReceiver.
Properties for a MjmlTemplate.
Properties for a SamlProvider.
App Home configuration.
Events API configuration for the app.
Interactivity configuration for the app.
OAuth configuration for the app.
Properties for a Slack app manifest.
Settings section of the app config pages.
Shortcut configuration.
Slash command configuration.
Workflow step.
Properties for a SlackApp.
Properties for a SlackEvents.
Bot user configuration.
Properties for a SlackTextract.
Properties for a SslServerTest.
Properties for a StateMachineCustomResourceProvider.
Properties for a StaticWebsite.
Properties for a ToolkitCleaner.
Properties for a UrlShortener.

# Interfaces

Mirror a repository to AWS CodeCommit on schedule.
A source repository for AWS CodeCommit mirroring.
Creates a DMARC record in Route 53 and invokes a Lambda function to process incoming reports.
Roll your ECS service tasks on schedule or with a rule.
Receive emails through SES, save them to S3 and invokes a Lambda function.
A State Machine.
SES email template from [MJML](https://mjml.io/).
The rule or schedule that should trigger a roll.
Principal entity that represents a SAML federated identity provider.
Create a SAML identity provider.
A Slack application deployed with a manifest.
A Slack app manifest.
A Slack app manifest definition.
Send Slack events to Amazon EventBridge.
Extract text from images posted to Slack using Amazon Textract.
Perform SSL server test for a hostname.
A state machine custom resource provider.
A CloudFront static website hosted on S3.
Clean unused S3 and ECR assets from your CDK Toolkit.
URL shortener.

# Type aliases

The DMARC alignment mode.
The DMARC policy to apply to messages that fail DMARC compliance.
Type of shortcuts.
SSL Server test grade.