API Reference

Constructs

CodeCommitMirror

Mirror a repository to AWS CodeCommit on schedule.

Initializers

import { CodeCommitMirror } from 'cloudstructs'

new CodeCommitMirror(scope: Construct, id: string, props: CodeCommitMirrorProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`CodeCommitMirrorProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: CodeCommitMirrorProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { CodeCommitMirror } from 'cloudstructs'

CodeCommitMirror.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

DmarcReporter

Creates a DMARC record in Route 53 and invokes a Lambda function to process incoming reports.

Initializers

import { DmarcReporter } from 'cloudstructs'

new DmarcReporter(scope: Construct, id: string, props: DmarcReporterProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`DmarcReporterProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: DmarcReporterProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { DmarcReporter } from 'cloudstructs'

DmarcReporter.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

EcsServiceRoller

Roll your ECS service tasks on schedule or with a rule.

Initializers

import { EcsServiceRoller } from 'cloudstructs'

new EcsServiceRoller(scope: Construct, id: string, props: EcsServiceRollerProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`EcsServiceRollerProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: EcsServiceRollerProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { EcsServiceRoller } from 'cloudstructs'

EcsServiceRoller.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

EmailReceiver

Receive emails through SES, save them to S3 and invokes a Lambda function.

Initializers

import { EmailReceiver } from 'cloudstructs'

new EmailReceiver(scope: Construct, id: string, props: EmailReceiverProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`EmailReceiverProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: EmailReceiverProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { EmailReceiver } from 'cloudstructs'

EmailReceiver.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`bucket`	`aws-cdk-lib.aws_s3.Bucket`	The S3 bucket where emails are delivered.
`topic`	`aws-cdk-lib.aws_sns.ITopic`	The SNS topic that is notified when emails are delivered to S3.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`bucket`^Required

public readonly bucket: Bucket;

Type: aws-cdk-lib.aws_s3.Bucket

The S3 bucket where emails are delivered.

`topic`^Required

public readonly topic: ITopic;

Type: aws-cdk-lib.aws_sns.ITopic

The SNS topic that is notified when emails are delivered to S3.

MjmlTemplate

SES email template from MJML.

Initializers

import { MjmlTemplate } from 'cloudstructs'

new MjmlTemplate(scope: Construct, id: string, props: MjmlTemplateProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`MjmlTemplateProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: MjmlTemplateProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { MjmlTemplate } from 'cloudstructs'

MjmlTemplate.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`templateName`	`string`	The name of the template.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`templateName`^Required

public readonly templateName: string;

Type: string

The name of the template.

SamlIdentityProvider

Create a SAML identity provider.

Initializers

import { SamlIdentityProvider } from 'cloudstructs'

new SamlIdentityProvider(scope: Construct, id: string, props: SamlIdentityProviderProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`SamlIdentityProviderProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: SamlIdentityProviderProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { SamlIdentityProvider } from 'cloudstructs'

SamlIdentityProvider.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`samlIdentityProviderArn`	`string`	The ARN of the SAML identity provider.

`node`^Required

Deprecated: use SamlProvider from aws-cdk-lib/aws-iam

public readonly node: Node;

Type: constructs.Node

The tree node.

`samlIdentityProviderArn`^Required

Deprecated: use SamlProvider from aws-cdk-lib/aws-iam

public readonly samlIdentityProviderArn: string;

Type: string

The ARN of the SAML identity provider.

SlackApp

A Slack application deployed with a manifest.

https://api.slack.com/reference/manifests

Initializers

import { SlackApp } from 'cloudstructs'

new SlackApp(scope: Construct, id: string, props: SlackAppProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`SlackAppProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: SlackAppProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { SlackApp } from 'cloudstructs'

SlackApp.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`appId`	`string`	The ID of the application.
`clientId`	`string`	A dynamic reference to the client ID of the app.
`clientSecret`	`string`	A dynamic reference to the client secret of the app.
`credentials`	`aws-cdk-lib.aws_secretsmanager.ISecret`	An AWS Secrets Manager secret containing the credentials of the application.
`signingSecret`	`string`	A dynamic reference to the signing secret of the app.
`verificationToken`	`string`	A dynamic reference to the verification token of the app.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`appId`^Required

public readonly appId: string;

Type: string

The ID of the application.

`clientId`^Required

public readonly clientId: string;

Type: string

A dynamic reference to the client ID of the app.

`clientSecret`^Required

public readonly clientSecret: string;

Type: string

A dynamic reference to the client secret of the app.

`credentials`^Required

public readonly credentials: ISecret;

Type: aws-cdk-lib.aws_secretsmanager.ISecret

An AWS Secrets Manager secret containing the credentials of the application.

{
  "appId": "...",
  "clientId": "...",
  "clientSecret": "...",
  "verificationToken": "...",
  "signingSecret": "..."
}

`signingSecret`^Required

public readonly signingSecret: string;

Type: string

A dynamic reference to the signing secret of the app.

`verificationToken`^Required

public readonly verificationToken: string;

Type: string

A dynamic reference to the verification token of the app.

SlackEvents

Send Slack events to Amazon EventBridge.

Initializers

import { SlackEvents } from 'cloudstructs'

new SlackEvents(scope: Construct, id: string, props: SlackEventsProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`SlackEventsProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: SlackEventsProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { SlackEvents } from 'cloudstructs'

SlackEvents.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`eventBus`	`aws-cdk-lib.aws_events.EventBus`	The custom event bus where Slack events are sent.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`eventBus`^Optional

public readonly eventBus: EventBus;

Type: aws-cdk-lib.aws_events.EventBus

The custom event bus where Slack events are sent.

SlackTextract

Extract text from images posted to Slack using Amazon Textract.

Initializers

import { SlackTextract } from 'cloudstructs'

new SlackTextract(scope: Construct, id: string, props: SlackTextractProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`SlackTextractProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: SlackTextractProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { SlackTextract } from 'cloudstructs'

SlackTextract.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

SslServerTest

Perform SSL server test for a hostname.

Initializers

import { SslServerTest } from 'cloudstructs'

new SslServerTest(scope: Construct, id: string, props: SslServerTestProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`SslServerTestProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: SslServerTestProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { SslServerTest } from 'cloudstructs'

SslServerTest.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`alarmTopic`	`aws-cdk-lib.aws_sns.ITopic`	The topic to which the SSL test results are sent when the grade is below the minimum grade.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`alarmTopic`^Required

public readonly alarmTopic: ITopic;

Type: aws-cdk-lib.aws_sns.ITopic

The topic to which the SSL test results are sent when the grade is below the minimum grade.

StateMachineCustomResourceProvider

A state machine custom resource provider.

Initializers

import { StateMachineCustomResourceProvider } from 'cloudstructs'

new StateMachineCustomResourceProvider(scope: Construct, id: string, props: StateMachineCustomResourceProviderProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`StateMachineCustomResourceProviderProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: StateMachineCustomResourceProviderProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { StateMachineCustomResourceProvider } from 'cloudstructs'

StateMachineCustomResourceProvider.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`serviceToken`	`string`	The service token.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`serviceToken`^Required

public readonly serviceToken: string;

Type: string

The service token.

StaticWebsite

A CloudFront static website hosted on S3.

Initializers

import { StaticWebsite } from 'cloudstructs'

new StaticWebsite(scope: Construct, id: string, props: StaticWebsiteProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`StaticWebsiteProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: StaticWebsiteProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { StaticWebsite } from 'cloudstructs'

StaticWebsite.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`defaultSecurityHeadersBehavior`	`aws-cdk-lib.aws_cloudfront.ResponseSecurityHeadersBehavior`	Best practice security headers used as default.
`bucket`	`aws-cdk-lib.aws_s3.Bucket`	The S3 bucket of this static website.
`distribution`	`aws-cdk-lib.aws_cloudfront.Distribution`	The CloudFront distribution of this static website.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`defaultSecurityHeadersBehavior`^Required

public readonly defaultSecurityHeadersBehavior: ResponseSecurityHeadersBehavior;

Type: aws-cdk-lib.aws_cloudfront.ResponseSecurityHeadersBehavior

Best practice security headers used as default.

`bucket`^Required

public readonly bucket: Bucket;

Type: aws-cdk-lib.aws_s3.Bucket

The S3 bucket of this static website.

`distribution`^Required

public readonly distribution: Distribution;

Type: aws-cdk-lib.aws_cloudfront.Distribution

The CloudFront distribution of this static website.

ToolkitCleaner

Clean unused S3 and ECR assets from your CDK Toolkit.

Initializers

import { ToolkitCleaner } from 'cloudstructs'

new ToolkitCleaner(scope: Construct, id: string, props?: ToolkitCleanerProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`ToolkitCleanerProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Optional

Type: ToolkitCleanerProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { ToolkitCleaner } from 'cloudstructs'

ToolkitCleaner.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

UrlShortener

URL shortener.

Initializers

import { UrlShortener } from 'cloudstructs'

new UrlShortener(scope: Construct, id: string, props: UrlShortenerProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`UrlShortenerProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: UrlShortenerProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`grantInvoke`	Grant access to invoke the URL shortener if protected by IAM authorization.

`toString`

public toString(): string

Returns a string representation of this construct.

`grantInvoke`

public grantInvoke(grantee: IGrantable): Grant

Grant access to invoke the URL shortener if protected by IAM authorization.

`grantee`^Required

Type: aws-cdk-lib.aws_iam.IGrantable

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { UrlShortener } from 'cloudstructs'

UrlShortener.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`api`	`aws-cdk-lib.aws_apigateway.RestApi`	The underlying API Gateway REST API.
`apiEndpoint`	`string`	The endpoint of the URL shortener API.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`api`^Required

public readonly api: RestApi;

Type: aws-cdk-lib.aws_apigateway.RestApi

The underlying API Gateway REST API.

`apiEndpoint`^Required

public readonly apiEndpoint: string;

Type: string

The endpoint of the URL shortener API.

Structs

CodeCommitMirrorProps

Properties for a CodeCommitMirror.

Initializer

import { CodeCommitMirrorProps } from 'cloudstructs'

const codeCommitMirrorProps: CodeCommitMirrorProps = { ... }

Properties

Name	Type	Description
`cluster`	`aws-cdk-lib.aws_ecs.ICluster`	The ECS cluster where to run the mirroring operation.
`repository`	`CodeCommitMirrorSourceRepository`	The source repository.
`schedule`	`aws-cdk-lib.aws_events.Schedule`	The schedule for the mirroring operation.
`subnetSelection`	`aws-cdk-lib.aws_ec2.SubnetSelection`	Where to run the mirroring Fargate tasks.

`cluster`^Required

public readonly cluster: ICluster;

Type: aws-cdk-lib.aws_ecs.ICluster

The ECS cluster where to run the mirroring operation.

`repository`^Required

public readonly repository: CodeCommitMirrorSourceRepository;

Type: CodeCommitMirrorSourceRepository

The source repository.

`schedule`^Optional

public readonly schedule: Schedule;

Type: aws-cdk-lib.aws_events.Schedule
Default: everyday at midnight

The schedule for the mirroring operation.

`subnetSelection`^Optional

public readonly subnetSelection: SubnetSelection;

Type: aws-cdk-lib.aws_ec2.SubnetSelection
Default: public subnets

Where to run the mirroring Fargate tasks.

DmarcReporterProps

Properties for a DmarcReporter.

Initializer

import { DmarcReporterProps } from 'cloudstructs'

const dmarcReporterProps: DmarcReporterProps = { ... }

Properties

Name	Type	Description
`dmarcPolicy`	`DmarcPolicy`	The DMARC policy to apply to messages that fail DMARC compliance.
`function`	`aws-cdk-lib.aws_lambda.IFunction`	A Lambda function to invoke after the message is saved to S3.
`hostedZone`	`aws-cdk-lib.aws_route53.IHostedZone`	The Route 53 hosted zone to create the DMARC record in.
`receiptRuleSet`	`aws-cdk-lib.aws_ses.IReceiptRuleSet`	The SES receipt rule set where a receipt rule will be added.
`additionalEmailAddresses`	`string[]`	Additional email addresses to send DMARC reports to.
`afterRule`	`aws-cdk-lib.aws_ses.IReceiptRule`	An existing rule after which the new rule will be placed in the rule set.
`dmarcDkimAlignment`	`DmarcAlignment`	The alignment mode to use for DKIM signatures.
`dmarcPercentage`	`number`	The percentage of messages that should be checked for DMARC compliance.
`dmarcSpfAlignment`	`DmarcAlignment`	The alignment mode to use for SPF signatures.
`dmarcSubdomainPolicy`	`DmarcPolicy`	The DMARC policy to apply to messages that fail DMARC compliance for subdomains.
`emailAddress`	`string`	The email address to send DMARC reports to.

`dmarcPolicy`^Required

public readonly dmarcPolicy: DmarcPolicy;

Type: DmarcPolicy

The DMARC policy to apply to messages that fail DMARC compliance.

This can be one of the following values:

none: Do not apply any special handling to messages that fail DMARC compliance.
quarantine: Quarantine messages that fail DMARC compliance.
reject: Reject messages that fail DMARC compliance.

`function`^Required

public readonly function: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

A Lambda function to invoke after the message is saved to S3.

The Lambda function will be invoked with a SESMessage as event.

`hostedZone`^Required

public readonly hostedZone: IHostedZone;

Type: aws-cdk-lib.aws_route53.IHostedZone

The Route 53 hosted zone to create the DMARC record in.

`receiptRuleSet`^Required

public readonly receiptRuleSet: IReceiptRuleSet;

Type: aws-cdk-lib.aws_ses.IReceiptRuleSet

The SES receipt rule set where a receipt rule will be added.

`additionalEmailAddresses`^Optional

public readonly additionalEmailAddresses: string[];

Type: string[]

Additional email addresses to send DMARC reports to.

`afterRule`^Optional

public readonly afterRule: IReceiptRule;

Type: aws-cdk-lib.aws_ses.IReceiptRule
Default: The new rule is inserted at the beginning of the rule list.

An existing rule after which the new rule will be placed in the rule set.

`dmarcDkimAlignment`^Optional

public readonly dmarcDkimAlignment: DmarcAlignment;

Type: DmarcAlignment
Default: relaxed

The alignment mode to use for DKIM signatures.

This can be one of the following values:

relaxed: Use relaxed alignment mode.
strict: Use strict alignment mode.

`dmarcPercentage`^Optional

public readonly dmarcPercentage: number;

Type: number
Default: 100

The percentage of messages that should be checked for DMARC compliance.

This is a value between 0 and 100.

`dmarcSpfAlignment`^Optional

public readonly dmarcSpfAlignment: DmarcAlignment;

Type: DmarcAlignment
Default: relaxed

The alignment mode to use for SPF signatures.

This can be one of the following values:

relaxed: Use relaxed alignment mode.
strict: Use strict alignment mode.

`dmarcSubdomainPolicy`^Optional

public readonly dmarcSubdomainPolicy: DmarcPolicy;

Type: DmarcPolicy
Default: inherited from dmarcPolicy

The DMARC policy to apply to messages that fail DMARC compliance for subdomains.

This can be one of the following values:

none: Do not apply any special handling to messages that fail DMARC compliance.
quarantine: Quarantine messages that fail DMARC compliance.
reject: Reject messages that fail DMARC compliance.

`emailAddress`^Optional

public readonly emailAddress: string;

Type: string
Default: dmarc-reports@${hostedZone.zoneName}

The email address to send DMARC reports to.

This email address must be verified in SES.

EcsServiceRollerProps

Properties for a EcsServiceRoller.

Initializer

import { EcsServiceRollerProps } from 'cloudstructs'

const ecsServiceRollerProps: EcsServiceRollerProps = { ... }

Properties

Name	Type	Description
`cluster`	`aws-cdk-lib.aws_ecs.ICluster`	The ECS cluster where the services run.
`service`	`aws-cdk-lib.aws_ecs.IService`	The ECS service for which tasks should be rolled.
`trigger`	`RollTrigger`	The rule or schedule that should trigger a roll.

`cluster`^Required

public readonly cluster: ICluster;

Type: aws-cdk-lib.aws_ecs.ICluster

The ECS cluster where the services run.

`service`^Required

public readonly service: IService;

Type: aws-cdk-lib.aws_ecs.IService

The ECS service for which tasks should be rolled.

`trigger`^Optional

public readonly trigger: RollTrigger;

Type: RollTrigger
Default: roll everyday at midnight

The rule or schedule that should trigger a roll.

EmailReceiverProps

Properties for an EmailReceiver.

Initializer

import { EmailReceiverProps } from 'cloudstructs'

const emailReceiverProps: EmailReceiverProps = { ... }

Properties

Name	Type	Description
`receiptRuleSet`	`aws-cdk-lib.aws_ses.IReceiptRuleSet`	The SES receipt rule set where a receipt rule will be added.
`recipients`	`string[]`	The recipients for which emails should be received.
`afterRule`	`aws-cdk-lib.aws_ses.IReceiptRule`	An existing rule after which the new rule will be placed in the rule set.
`enabled`	`boolean`	Whether the receiver is active.
`function`	`aws-cdk-lib.aws_lambda.IFunction`	A Lambda function to invoke after the message is saved to S3.
`sourceWhitelist`	`string`	A regular expression to whitelist source email addresses.

`receiptRuleSet`^Required

public readonly receiptRuleSet: IReceiptRuleSet;

Type: aws-cdk-lib.aws_ses.IReceiptRuleSet

The SES receipt rule set where a receipt rule will be added.

`recipients`^Required

public readonly recipients: string[];

Type: string[]

The recipients for which emails should be received.

`afterRule`^Optional

public readonly afterRule: IReceiptRule;

Type: aws-cdk-lib.aws_ses.IReceiptRule
Default: The new rule is inserted at the beginning of the rule list.

An existing rule after which the new rule will be placed in the rule set.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean
Default: true

Whether the receiver is active.

`function`^Optional

public readonly function: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

A Lambda function to invoke after the message is saved to S3.

The Lambda function will be invoked with a SESMessage as event.

`sourceWhitelist`^Optional

public readonly sourceWhitelist: string;

Type: string
Default: no whitelisting of source email addresses

A regular expression to whitelist source email addresses.

MjmlTemplateProps

Properties for a MjmlTemplate.

Initializer

import { MjmlTemplateProps } from 'cloudstructs'

const mjmlTemplateProps: MjmlTemplateProps = { ... }

Properties

Name	Type	Description
`mjml`	`string`	The MJML for the email.
`subject`	`string`	The subject line of the email.
`templateName`	`string`	The name of the template.

`mjml`^Required

public readonly mjml: string;

Type: string

The MJML for the email.

`subject`^Required

public readonly subject: string;

Type: string

The subject line of the email.

`templateName`^Optional

public readonly templateName: string;

Type: string
Default: a CloudFormation generated name

The name of the template.

SamlIdentityProviderProps

Properties for a SamlProvider.

Initializer

import { SamlIdentityProviderProps } from 'cloudstructs'

const samlIdentityProviderProps: SamlIdentityProviderProps = { ... }

Properties

Name	Type	Description
`metadataDocument`	`string`	An XML document generated by an identity provider (IdP) that supports SAML 2.0.
`name`	`string`	A name for the SAML identity provider.

`metadataDocument`^Required

Deprecated: use SamlProviderProps from aws-cdk-lib/aws-iam

public readonly metadataDocument: string;

Type: string

An XML document generated by an identity provider (IdP) that supports SAML 2.0.

The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

`name`^Optional

Deprecated: use SamlProviderProps from aws-cdk-lib/aws-iam

public readonly name: string;

Type: string
Default: derived for the node's unique id

A name for the SAML identity provider.

SlackAppManifestAppHome

App Home configuration.

https://api.slack.com/surfaces/tabs

Initializer

import { SlackAppManifestAppHome } from 'cloudstructs'

const slackAppManifestAppHome: SlackAppManifestAppHome = { ... }

Properties

Name	Type	Description
`homeTab`	`boolean`	Wether the Home tab is enabled.
`messagesTab`	`boolean`	Wether the Messages is enabled.
`messagesTabReadOnly`	`boolean`	Whether the users can send messages to your app in the Messages tab of your App Home.

`homeTab`^Optional

public readonly homeTab: boolean;

Type: boolean
Default: false

Wether the Home tab is enabled.

`messagesTab`^Optional

public readonly messagesTab: boolean;

Type: boolean
Default: false

Wether the Messages is enabled.

`messagesTabReadOnly`^Optional

public readonly messagesTabReadOnly: boolean;

Type: boolean
Default: false

Whether the users can send messages to your app in the Messages tab of your App Home.

SlackAppManifestEventSubscriptions

Events API configuration for the app.

https://api.slack.com/events-api

Initializer

import { SlackAppManifestEventSubscriptions } from 'cloudstructs'

const slackAppManifestEventSubscriptions: SlackAppManifestEventSubscriptions = { ... }

Properties

Name	Type	Description
`requestUrl`	`string`	The full https URL that acts as the Events API request URL.
`botEvents`	`string[]`	Event types you want the app to subscribe to.
`userEvents`	`string[]`	Event types you want the app to subscribe to on behalf of authorized users.

`requestUrl`^Required

public readonly requestUrl: string;

Type: string

The full https URL that acts as the Events API request URL.

https://api.slack.com/events-api#the-events-api__subscribing-to-event-types__events-api-request-urls

`botEvents`^Optional

public readonly botEvents: string[];

Type: string[]

Event types you want the app to subscribe to.

A maximum of 100 event types can be used

https://api.slack.com/events

`userEvents`^Optional

public readonly userEvents: string[];

Type: string[]

Event types you want the app to subscribe to on behalf of authorized users.

A maximum of 100 event types can be used.

SlackAppManifestInteractivity

Interactivity configuration for the app.

https://api.slack.com/interactivity/handling#setup

Initializer

import { SlackAppManifestInteractivity } from 'cloudstructs'

const slackAppManifestInteractivity: SlackAppManifestInteractivity = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Whether or not interactivity features are enabled.
`messageMenuOptionsUrl`	`string`	The full https URL that acts as th interactive Options Load URL.
`requestUrl`	`string`	The full https URL that acts as the interactive Request URL.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean
Default: true

Whether or not interactivity features are enabled.

`messageMenuOptionsUrl`^Optional

public readonly messageMenuOptionsUrl: string;

Type: string

The full https URL that acts as th interactive Options Load URL.

`requestUrl`^Optional

public readonly requestUrl: string;

Type: string

The full https URL that acts as the interactive Request URL.

SlackAppManifestOauthConfig

OAuth configuration for the app.

Initializer

import { SlackAppManifestOauthConfig } from 'cloudstructs'

const slackAppManifestOauthConfig: SlackAppManifestOauthConfig = { ... }

Properties

Name	Type	Description
`botScopes`	`string[]`	Bot scopes to request upon app installation.
`redirectUrls`	`string[]`	OAuth redirect URLs.
`userScopes`	`string[]`	User scopes to request upon app installation.

`botScopes`^Optional

public readonly botScopes: string[];

Type: string[]

Bot scopes to request upon app installation.

A maximum of 255 scopes can be included.

https://api.slack.com/scopes

`redirectUrls`^Optional

public readonly redirectUrls: string[];

Type: string[]

OAuth redirect URLs.

A maximum of 1000 redirect URLs can be included.

https://api.slack.com/authentication/oauth-v2#redirect_urls

`userScopes`^Optional

public readonly userScopes: string[];

Type: string[]

User scopes to request upon app installation.

A maximum of 255 scopes can be included.

https://api.slack.com/scopes

SlackAppManifestProps

Properties for a Slack app manifest.

https://api.slack.com/reference/manifests

Initializer

import { SlackAppManifestProps } from 'cloudstructs'

const slackAppManifestProps: SlackAppManifestProps = { ... }

Properties

Name	Type	Description
`name`	`string`	The name of the app.
`allowedIpAddressRanges`	`string[]`	An array of IP addresses that conform to the Allowed IP Ranges feature.
`appHome`	`SlackAppManifestAppHome`	App Home configuration.
`backgroundColor`	`string`	A hex color value that specifies the background color used on hovercards that display information about your app.
`botUser`	`SlackkAppManifestBotUser`	Bot user configuration.
`description`	`string`	A short description of the app for display to users.
`eventSubscriptions`	`SlackAppManifestEventSubscriptions`	Events API configuration for the app.
`interactivity`	`SlackAppManifestInteractivity`	Interactivity configuration for the app.
`longDescription`	`string`	A longer version of the description of the app.
`majorVersion`	`number`	The major version of the manifest schema to target.
`minorVersion`	`number`	The minor version of the manifest schema to target.
`oauthConfig`	`SlackAppManifestOauthConfig`	OAuth configuration for the app.
`orgDeploy`	`boolean`	Whether org-wide deploy is enabled.
`shortcuts`	`SlackAppManifestShortcut[]`	Shortcuts configuration.
`slashCommands`	`SlackAppManifestSlashCommand[]`	Slash commands configuration.
`socketMode`	`boolean`	Whether Socket Mode is enabled.
`unfurlDomains`	`string[]`	Valid unfurl domains to register.
`workflowSteps`	`SlackAppManifestWorkflowStep[]`	Workflow steps.

`name`^Required

public readonly name: string;

Type: string

The name of the app.

Maximum length is 35 characters.

`allowedIpAddressRanges`^Optional

public readonly allowedIpAddressRanges: string[];

Type: string[]

An array of IP addresses that conform to the Allowed IP Ranges feature.

https://api.slack.com/authentication/best-practices#ip_allowlisting

`appHome`^Optional

public readonly appHome: SlackAppManifestAppHome;

Type: SlackAppManifestAppHome

App Home configuration.

https://api.slack.com/surfaces/tabs

`backgroundColor`^Optional

public readonly backgroundColor: string;

Type: string

A hex color value that specifies the background color used on hovercards that display information about your app.

Can be 3-digit (#000) or 6-digit (#000000) hex values with or without #

`botUser`^Optional

public readonly botUser: SlackkAppManifestBotUser;

Type: SlackkAppManifestBotUser

Bot user configuration.

https://api.slack.com/bot-users

`description`^Optional

public readonly description: string;

Type: string
Default: no short description

A short description of the app for display to users.

Maximum length is 140 characters.

`eventSubscriptions`^Optional

public readonly eventSubscriptions: SlackAppManifestEventSubscriptions;

Type: SlackAppManifestEventSubscriptions

Events API configuration for the app.

https://api.slack.com/events-api

`interactivity`^Optional

public readonly interactivity: SlackAppManifestInteractivity;

Type: SlackAppManifestInteractivity

Interactivity configuration for the app.

`longDescription`^Optional

public readonly longDescription: string;

Type: string

A longer version of the description of the app.

Maximum length is 4000 characters.

`majorVersion`^Optional

public readonly majorVersion: number;

Type: number
Default: do not target a specific major version

The major version of the manifest schema to target.

`minorVersion`^Optional

public readonly minorVersion: number;

Type: number
Default: do not target a specific minor version

The minor version of the manifest schema to target.

`oauthConfig`^Optional

public readonly oauthConfig: SlackAppManifestOauthConfig;

Type: SlackAppManifestOauthConfig

OAuth configuration for the app.

`orgDeploy`^Optional

public readonly orgDeploy: boolean;

Type: boolean
Default: false

Whether org-wide deploy is enabled.

https://api.slack.com/enterprise/apps

`shortcuts`^Optional

public readonly shortcuts: SlackAppManifestShortcut[];

Type: SlackAppManifestShortcut[]

Shortcuts configuration.

A maximum of 5 shortcuts can be included.

https://api.slack.com/interactivity/shortcuts

`slashCommands`^Optional

public readonly slashCommands: SlackAppManifestSlashCommand[];

Type: SlackAppManifestSlashCommand[]

Slash commands configuration.

A maximum of 5 slash commands can be included.

https://api.slack.com/interactivity/slash-commands

`socketMode`^Optional

public readonly socketMode: boolean;

Type: boolean
Default: false

Whether Socket Mode is enabled.

https://api.slack.com/apis/connections/socket

`unfurlDomains`^Optional

public readonly unfurlDomains: string[];

Type: string[]

Valid unfurl domains to register.

A maximum of 5 unfurl domains can be included.

https://api.slack.com/reference/messaging/link-unfurling#configuring_domains

`workflowSteps`^Optional

public readonly workflowSteps: SlackAppManifestWorkflowStep[];

Type: SlackAppManifestWorkflowStep[]

Workflow steps.

A maximum of 10 workflow steps can be included.

https://api.slack.com/workflows/steps

SlackAppManifestSettings

Settings section of the app config pages.

Initializer

import { SlackAppManifestSettings } from 'cloudstructs'

const slackAppManifestSettings: SlackAppManifestSettings = { ... }

Properties

Name	Type	Description
`allowedIpAddressRanges`	`string[]`	An array of IP addresses that conform to the Allowed IP Ranges feature.
`eventSubscriptions`	`SlackAppManifestEventSubscriptions`	Events API configuration for the app.
`interactivity`	`SlackAppManifestInteractivity`	Interactivity configuration for the app.
`orgDeploy`	`boolean`	Whether org-wide deploy is enabled.
`socketMode`	`boolean`	Whether Socket Mode is enabled.

`allowedIpAddressRanges`^Optional

public readonly allowedIpAddressRanges: string[];

Type: string[]

An array of IP addresses that conform to the Allowed IP Ranges feature.

https://api.slack.com/authentication/best-practices#ip_allowlisting

`eventSubscriptions`^Optional

public readonly eventSubscriptions: SlackAppManifestEventSubscriptions;

Type: SlackAppManifestEventSubscriptions

Events API configuration for the app.

https://api.slack.com/events-api

`interactivity`^Optional

public readonly interactivity: SlackAppManifestInteractivity;

Type: SlackAppManifestInteractivity

Interactivity configuration for the app.

`orgDeploy`^Optional

public readonly orgDeploy: boolean;

Type: boolean
Default: false

Whether org-wide deploy is enabled.

https://api.slack.com/enterprise/apps

`socketMode`^Optional

public readonly socketMode: boolean;

Type: boolean
Default: false

Whether Socket Mode is enabled.

https://api.slack.com/apis/connections/socket

SlackAppManifestShortcut

Shortcut configuration.

https://api.slack.com/interactivity/shortcuts

Initializer

import { SlackAppManifestShortcut } from 'cloudstructs'

const slackAppManifestShortcut: SlackAppManifestShortcut = { ... }

Properties

Name	Type	Description
`callbackId`	`string`	The callback ID of the shortcut.
`description`	`string`	A short description of the shortcut.
`name`	`string`	The name of the shortcut.
`type`	`SlackAppManifestShortcutType`	The type of shortcut.

`callbackId`^Required

public readonly callbackId: string;

Type: string

The callback ID of the shortcut.

Maximum length is 255 characters.

`description`^Required

public readonly description: string;

Type: string

A short description of the shortcut.

Maximum length is 150 characters

`name`^Required

public readonly name: string;

Type: string

The name of the shortcut.

`type`^Required

public readonly type: SlackAppManifestShortcutType;

Type: SlackAppManifestShortcutType

The type of shortcut.

https://api.slack.com/interactivity/shortcuts

SlackAppManifestSlashCommand

Slash command configuration.

https://api.slack.com/interactivity/slash-commands

Initializer

import { SlackAppManifestSlashCommand } from 'cloudstructs'

const slackAppManifestSlashCommand: SlackAppManifestSlashCommand = { ... }

Properties

Name	Type	Description
`command`	`string`	The actual slash command.
`description`	`string`	The description of the slash command.
`shouldEscape`	`boolean`	Whether channels, users, and links typed with the slash command should be escaped.
`url`	`string`	The full https URL that acts as the slash command's request URL.
`usageHint`	`string`	The short usage hint about the slash command for users.

`command`^Required

public readonly command: string;

Type: string

The actual slash command.

Maximum length is 32 characters

`description`^Required

public readonly description: string;

Type: string

The description of the slash command.

Maximum length is 2000 characters.

`shouldEscape`^Optional

public readonly shouldEscape: boolean;

Type: boolean
Default: false

Whether channels, users, and links typed with the slash command should be escaped.

`url`^Optional

public readonly url: string;

Type: string

The full https URL that acts as the slash command's request URL.

https://api.slack.com/interactivity/slash-commands#creating_commands

`usageHint`^Optional

public readonly usageHint: string;

Type: string

The short usage hint about the slash command for users.

Maximum length is 1000 characters.

SlackAppManifestWorkflowStep

Workflow step.

https://api.slack.com/workflows/steps

Initializer

import { SlackAppManifestWorkflowStep } from 'cloudstructs'

const slackAppManifestWorkflowStep: SlackAppManifestWorkflowStep = { ... }

Properties

Name	Type	Description
`callbackId`	`string`	The callback ID of the workflow step.
`name`	`string`	The name of the workflow step.

`callbackId`^Required

public readonly callbackId: string;

Type: string

The callback ID of the workflow step.

Maximum length of 50 characters.

`name`^Required

public readonly name: string;

Type: string

The name of the workflow step.

Maximum length of 50 characters.

SlackAppProps

Properties for a SlackApp.

Initializer

import { SlackAppProps } from 'cloudstructs'

const slackAppProps: SlackAppProps = { ... }

Properties

Name	Type	Description
`configurationTokenSecret`	`aws-cdk-lib.aws_secretsmanager.ISecret`	An AWS Secrets Manager secret containing the app configuration token.
`manifest`	`SlackAppManifestDefinition`	The definition of the app manifest.
`credentialsSecret`	`aws-cdk-lib.aws_secretsmanager.ISecret`	The AWS Secrets Manager secret where to store the app credentials.

`configurationTokenSecret`^Required

public readonly configurationTokenSecret: ISecret;

Type: aws-cdk-lib.aws_secretsmanager.ISecret

An AWS Secrets Manager secret containing the app configuration token.

Must use the following JSON format:

{
  "refreshToken": "<token>"
}

`manifest`^Required

public readonly manifest: SlackAppManifestDefinition;

Type: SlackAppManifestDefinition

The definition of the app manifest.

https://api.slack.com/reference/manifests

`credentialsSecret`^Optional

public readonly credentialsSecret: ISecret;

Type: aws-cdk-lib.aws_secretsmanager.ISecret
Default: a new secret is created

The AWS Secrets Manager secret where to store the app credentials.

SlackEventsProps

Properties for a SlackEvents.

Initializer

import { SlackEventsProps } from 'cloudstructs'

const slackEventsProps: SlackEventsProps = { ... }

Properties

Name	Type	Description
`signingSecret`	`aws-cdk-lib.SecretValue`	The signing secret of the Slack app.
`apiName`	`string`	A name for the API Gateway resource.
`customEventBus`	`boolean`	Whether to use a custom event bus.

`signingSecret`^Required

public readonly signingSecret: SecretValue;

Type: aws-cdk-lib.SecretValue

The signing secret of the Slack app.

`apiName`^Optional

public readonly apiName: string;

Type: string
Default: SlackEventsApi

A name for the API Gateway resource.

`customEventBus`^Optional

public readonly customEventBus: boolean;

Type: boolean
Default: false

Whether to use a custom event bus.

SlackkAppManifestBotUser

Bot user configuration.

https://api.slack.com/bot-users

Initializer

import { SlackkAppManifestBotUser } from 'cloudstructs'

const slackkAppManifestBotUser: SlackkAppManifestBotUser = { ... }

Properties

Name	Type	Description
`displayName`	`string`	The display name of the bot user.
`alwaysOnline`	`boolean`	Whether the bot user will always appear to be online.

`displayName`^Required

public readonly displayName: string;

Type: string

The display name of the bot user.

Maximum length is 80 characters.

`alwaysOnline`^Optional

public readonly alwaysOnline: boolean;

Type: boolean
Default: false

Whether the bot user will always appear to be online.

SlackTextractProps

Properties for a SlackTextract.

Initializer

import { SlackTextractProps } from 'cloudstructs'

const slackTextractProps: SlackTextractProps = { ... }

Properties

Name	Type	Description
`appId`	`string`	The application id of the Slack app.
`botToken`	`aws-cdk-lib.SecretValue`	The bot token of the Slack app.
`signingSecret`	`aws-cdk-lib.SecretValue`	The signing secret of the Slack app.

`appId`^Required

public readonly appId: string;

Type: string

The application id of the Slack app.

`botToken`^Required

public readonly botToken: SecretValue;

Type: aws-cdk-lib.SecretValue

The bot token of the Slack app.

The following scopes are required: chat:write and files:read

`signingSecret`^Required

public readonly signingSecret: SecretValue;

Type: aws-cdk-lib.SecretValue

The signing secret of the Slack app.

SslServerTestProps

Properties for a SslServerTest.

Initializer

import { SslServerTestProps } from 'cloudstructs'

const sslServerTestProps: SslServerTestProps = { ... }

Properties

Name	Type	Description
`host`	`string`	The hostname to test.
`alarmTopic`	`aws-cdk-lib.aws_sns.ITopic`	The topic to which the results must be sent when the grade is below the minimum grade.
`minimumGrade`	`SslServerTestGrade`	Minimum grade for the test. The grade is calculated using the worst grade of all endpoints.
`schedule`	`aws-cdk-lib.aws_events.Schedule`	The schedule for the test.

`host`^Required

public readonly host: string;

Type: string

The hostname to test.

`alarmTopic`^Optional

public readonly alarmTopic: ITopic;

Type: aws-cdk-lib.aws_sns.ITopic
Default: a new topic is created

The topic to which the results must be sent when the grade is below the minimum grade.

`minimumGrade`^Optional

public readonly minimumGrade: SslServerTestGrade;

Type: SslServerTestGrade
Default: SslServerTestGrade.A_PLUS

Minimum grade for the test. The grade is calculated using the worst grade of all endpoints.

Used to send the results to an alarm SNS topic.

`schedule`^Optional

public readonly schedule: Schedule;

Type: aws-cdk-lib.aws_events.Schedule
Default: every day

The schedule for the test.

StateMachineCustomResourceProviderProps

Properties for a StateMachineCustomResourceProvider.

Initializer

import { StateMachineCustomResourceProviderProps } from 'cloudstructs'

const stateMachineCustomResourceProviderProps: StateMachineCustomResourceProviderProps = { ... }

Properties

Name	Type	Description
`stateMachine`	`IStateMachine`	The state machine.
`timeout`	`aws-cdk-lib.Duration`	Timeout.

`stateMachine`^Required

public readonly stateMachine: IStateMachine;

Type: IStateMachine

The state machine.

`timeout`^Optional

public readonly timeout: Duration;

Type: aws-cdk-lib.Duration
Default: Duration.minutes(30)

Timeout.

StaticWebsiteProps

Properties for a StaticWebsite.

Initializer

import { StaticWebsiteProps } from 'cloudstructs'

const staticWebsiteProps: StaticWebsiteProps = { ... }

Properties

Name	Type	Description
`domainName`	`string`	The domain name for this static website.
`hostedZone`	`aws-cdk-lib.aws_route53.IHostedZone`	The hosted zone where records should be added.
`backendConfiguration`	`any`	A backend configuration that will be saved as `config.json` in the S3 bucket of the static website.
`cachePolicy`	`aws-cdk-lib.aws_cloudfront.ICachePolicy`	Cache policy for the default behavior.
`edgeLambdas`	`aws-cdk-lib.aws_cloudfront.EdgeLambda[]`	The Lambda@Edge functions to invoke before serving the contents.
`redirects`	`string[]`	A list of domain names that should redirect to `domainName`.
`responseHeadersPolicy`	`aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicy`	Response headers policy for the default behavior.

`domainName`^Required

public readonly domainName: string;

Type: string

The domain name for this static website.

Example

www.my-static-website.com

`hostedZone`^Required

public readonly hostedZone: IHostedZone;

Type: aws-cdk-lib.aws_route53.IHostedZone

The hosted zone where records should be added.

`backendConfiguration`^Optional

public readonly backendConfiguration: any;

Type: any

A backend configuration that will be saved as config.json in the S3 bucket of the static website.

The frontend can query this config by doing fetch('/config.json').

Example

{ userPoolId: '1234', apiEndoint: 'https://www.my-api.com/api' }

`cachePolicy`^Optional

public readonly cachePolicy: ICachePolicy;

Type: aws-cdk-lib.aws_cloudfront.ICachePolicy
Default: CachePolicy.CACHING_OPTIMIZED

Cache policy for the default behavior.

`edgeLambdas`^Optional

public readonly edgeLambdas: EdgeLambda[];

Type: aws-cdk-lib.aws_cloudfront.EdgeLambda[]
Default: an origin request function that redirects all requests for a path to /index.html

The Lambda@Edge functions to invoke before serving the contents.

`redirects`^Optional

public readonly redirects: string[];

Type: string[]
Default: the domain name of the hosted zone

A list of domain names that should redirect to domainName.

`responseHeadersPolicy`^Optional

public readonly responseHeadersPolicy: ResponseHeadersPolicy;

Type: aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicy
Default: a new policy is created with best practice security headers

Response headers policy for the default behavior.

ToolkitCleanerProps

Properties for a ToolkitCleaner.

Initializer

import { ToolkitCleanerProps } from 'cloudstructs'

const toolkitCleanerProps: ToolkitCleanerProps = { ... }

Properties

Name	Type	Description
`cleanAssetsTimeout`	`aws-cdk-lib.Duration`	The timeout for the Lambda functions that clean assets.
`dryRun`	`boolean`	Only output number of assets and total size that would be deleted but without actually deleting assets.
`retainAssetsNewerThan`	`aws-cdk-lib.Duration`	Retain unused assets that were created recently.
`schedule`	`aws-cdk-lib.aws_events.Schedule`	The schedule for the cleaner.
`scheduleEnabled`	`boolean`	Whether to clean on schedule.

`cleanAssetsTimeout`^Optional

public readonly cleanAssetsTimeout: Duration;

Type: aws-cdk-lib.Duration
Default: Duration.minutes(5)

The timeout for the Lambda functions that clean assets.

`dryRun`^Optional

public readonly dryRun: boolean;

Type: boolean

Only output number of assets and total size that would be deleted but without actually deleting assets.

`retainAssetsNewerThan`^Optional

public readonly retainAssetsNewerThan: Duration;

Type: aws-cdk-lib.Duration
Default: all unused assets are removed

Retain unused assets that were created recently.

`schedule`^Optional

public readonly schedule: Schedule;

Type: aws-cdk-lib.aws_events.Schedule
Default: every day

The schedule for the cleaner.

`scheduleEnabled`^Optional

public readonly scheduleEnabled: boolean;

Type: boolean
Default: true

Whether to clean on schedule.

If you'd like to run the cleanup manually via the console, set to false.

UrlShortenerProps

Properties for a UrlShortener.

Initializer

import { UrlShortenerProps } from 'cloudstructs'

const urlShortenerProps: UrlShortenerProps = { ... }

Properties

Name	Type	Description
`hostedZone`	`aws-cdk-lib.aws_route53.IHostedZone`	The hosted zone for the short URLs domain.
`apiGatewayAuthorizer`	`aws-cdk-lib.aws_apigateway.IAuthorizer`	Authorizer for API gateway.
`apiGatewayEndpoint`	`aws-cdk-lib.aws_ec2.IInterfaceVpcEndpoint`	An interface VPC endpoint for API gateway.
`bucketName`	`string`	A name for the bucket saving the redirects.
`corsAllowOrigins`	`string[]`	Allowed origins for CORS.
`expiration`	`aws-cdk-lib.Duration`	Expiration for short urls.
`iamAuthorization`	`boolean`	Whether to use IAM authorization.
`recordName`	`string`	The record name to use in the hosted zone.

`hostedZone`^Required

public readonly hostedZone: IHostedZone;

Type: aws-cdk-lib.aws_route53.IHostedZone

The hosted zone for the short URLs domain.

`apiGatewayAuthorizer`^Optional

public readonly apiGatewayAuthorizer: IAuthorizer;

Type: aws-cdk-lib.aws_apigateway.IAuthorizer
Default: do not use an authorizer for the API

Authorizer for API gateway.

`apiGatewayEndpoint`^Optional

public readonly apiGatewayEndpoint: IInterfaceVpcEndpoint;

Type: aws-cdk-lib.aws_ec2.IInterfaceVpcEndpoint
Default: API is public

An interface VPC endpoint for API gateway.

Specifying this property will make the API private.

https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-apis.html

`bucketName`^Optional

public readonly bucketName: string;

Type: string
Default: derived from short link domain name

A name for the bucket saving the redirects.

`corsAllowOrigins`^Optional

public readonly corsAllowOrigins: string[];

Type: string[]
Default: CORS is not enabled

Allowed origins for CORS.

`expiration`^Optional

public readonly expiration: Duration;

Type: aws-cdk-lib.Duration
Default: cdk.Duration.days(365)

Expiration for short urls.

`iamAuthorization`^Optional

public readonly iamAuthorization: boolean;

Type: boolean
Default: do not use IAM authorization

Whether to use IAM authorization.

`recordName`^Optional

public readonly recordName: string;

Type: string
Default: zone root

The record name to use in the hosted zone.

Classes

CodeCommitMirrorSourceRepository

A source repository for AWS CodeCommit mirroring.

Initializers

import { CodeCommitMirrorSourceRepository } from 'cloudstructs'

new CodeCommitMirrorSourceRepository()

Name	Type	Description

Static Functions

Name	Description
`gitHub`	Public GitHub repository.
`private`	Private repository with HTTPS clone URL stored in a AWS Secrets Manager secret or a AWS Systems Manager secure string parameter.

`gitHub`

import { CodeCommitMirrorSourceRepository } from 'cloudstructs'

CodeCommitMirrorSourceRepository.gitHub(owner: string, name: string)

Public GitHub repository.

`owner`^Required

Type: string

`name`^Required

Type: string

`private`

import { CodeCommitMirrorSourceRepository } from 'cloudstructs'

CodeCommitMirrorSourceRepository.private(name: string, url: Secret)

Private repository with HTTPS clone URL stored in a AWS Secrets Manager secret or a AWS Systems Manager secure string parameter.

`name`^Required

Type: string

the repository name.

`url`^Required

Type: aws-cdk-lib.aws_ecs.Secret

the secret containing the HTTPS clone URL.

Properties

Name	Type	Description
`name`	`string`	The name of the repository.
`plainTextUrl`	`string`	The HTTPS clone URL in plain text, used for a public repository.
`secretUrl`	`aws-cdk-lib.aws_ecs.Secret`	The HTTPS clone URL if the repository is private.

`name`^Required

public readonly name: string;

Type: string

The name of the repository.

`plainTextUrl`^Optional

public readonly plainTextUrl: string;

Type: string

The HTTPS clone URL in plain text, used for a public repository.

`secretUrl`^Optional

public readonly secretUrl: Secret;

Type: aws-cdk-lib.aws_ecs.Secret

The HTTPS clone URL if the repository is private.

The secret should contain the username and/or token.

Example

`https://TOKEN@github.com/owner/name`
`https://USERNAME:TOKEN@bitbucket.org/owner/name.git`

RollTrigger

The rule or schedule that should trigger a roll.

Initializers

import { RollTrigger } from 'cloudstructs'

new RollTrigger()

Name	Type	Description

Static Functions

Name	Description
`fromRule`	Rule that should trigger a roll.
`fromSchedule`	Schedule that should trigger a roll.

`fromRule`

import { RollTrigger } from 'cloudstructs'

RollTrigger.fromRule(rule: Rule)

Rule that should trigger a roll.

`rule`^Required

Type: aws-cdk-lib.aws_events.Rule

`fromSchedule`

import { RollTrigger } from 'cloudstructs'

RollTrigger.fromSchedule(schedule: Schedule)

Schedule that should trigger a roll.

`schedule`^Required

Type: aws-cdk-lib.aws_events.Schedule

Properties

Name	Type	Description
`rule`	`aws-cdk-lib.aws_events.Rule`	Roll rule.
`schedule`	`aws-cdk-lib.aws_events.Schedule`	Roll schedule.

`rule`^Optional

public readonly rule: Rule;

Type: aws-cdk-lib.aws_events.Rule
Default: roll everyday at midnight

Roll rule.

`schedule`^Optional

public readonly schedule: Schedule;

Type: aws-cdk-lib.aws_events.Schedule
Default: roll everyday at midnight

Roll schedule.

SamlFederatedPrincipal

Principal entity that represents a SAML federated identity provider.

Initializers

import { SamlFederatedPrincipal } from 'cloudstructs'

new SamlFederatedPrincipal(identityProvider: SamlIdentityProvider)

Name	Type	Description
`identityProvider`	`SamlIdentityProvider`	No description.

`identityProvider`^Required

Type: SamlIdentityProvider

Methods

Name	Description
`addToAssumeRolePolicy`	Add the principal to the AssumeRolePolicyDocument.
`addToPolicy`	Add to the policy of this principal.
`addToPrincipalPolicy`	Add to the policy of this principal.
`dedupeString`	Return whether or not this principal is equal to the given principal.
`toJSON`	JSON-ify the principal.
`toString`	Returns a string representation of an object.
`withConditions`	Returns a new PrincipalWithConditions using this principal as the base, with the passed conditions added.
`withSessionTags`	Returns a new principal using this principal as the base, with session tags enabled.

`addToAssumeRolePolicy`

public addToAssumeRolePolicy(document: PolicyDocument): void

Add the principal to the AssumeRolePolicyDocument.

Add the statements to the AssumeRolePolicyDocument necessary to give this principal permissions to assume the given role.

`document`^Required

Type: aws-cdk-lib.aws_iam.PolicyDocument

`addToPolicy`

public addToPolicy(statement: PolicyStatement): boolean

Add to the policy of this principal.

`statement`^Required

Type: aws-cdk-lib.aws_iam.PolicyStatement

`addToPrincipalPolicy`

public addToPrincipalPolicy(_statement: PolicyStatement): AddToPrincipalPolicyResult

Add to the policy of this principal.

`_statement`^Required

Type: aws-cdk-lib.aws_iam.PolicyStatement

`dedupeString`

public dedupeString(): string

Return whether or not this principal is equal to the given principal.

`toJSON`

public toJSON(): {[ key: string ]: string[]}

JSON-ify the principal.

Used when JSON.stringify() is called

`toString`

public toString(): string

Returns a string representation of an object.

`withConditions`

public withConditions(conditions: {[ key: string ]: any}): PrincipalBase

Returns a new PrincipalWithConditions using this principal as the base, with the passed conditions added.

When there is a value for the same operator and key in both the principal and the conditions parameter, the value from the conditions parameter will be used.

`conditions`^Required

Type: {[ key: string ]: any}

`withSessionTags`

public withSessionTags(): PrincipalBase

Returns a new principal using this principal as the base, with session tags enabled.

Properties

Name	Type	Description
`assumeRoleAction`	`string`	When this Principal is used in an AssumeRole policy, the action to use.
`grantPrincipal`	`aws-cdk-lib.aws_iam.IPrincipal`	The principal to grant permissions to.
`policyFragment`	`aws-cdk-lib.aws_iam.PrincipalPolicyFragment`	Return the policy fragment that identifies this principal in a Policy.
`principalAccount`	`string`	The AWS account ID of this principal.
`conditions`	`{[ key: string ]: any}`	The conditions under which the policy is in effect.
`federated`	`string`	federated identity provider (i.e. 'cognito-identity.amazonaws.com' for users authenticated through Cognito).

`assumeRoleAction`^Required

Deprecated: use SamlPrincipal from aws-cdk-lib/aws-iam

public readonly assumeRoleAction: string;

Type: string

When this Principal is used in an AssumeRole policy, the action to use.

`grantPrincipal`^Required

Deprecated: use SamlPrincipal from aws-cdk-lib/aws-iam

public readonly grantPrincipal: IPrincipal;

Type: aws-cdk-lib.aws_iam.IPrincipal

The principal to grant permissions to.

`policyFragment`^Required

Deprecated: use SamlPrincipal from aws-cdk-lib/aws-iam

public readonly policyFragment: PrincipalPolicyFragment;

Type: aws-cdk-lib.aws_iam.PrincipalPolicyFragment

Return the policy fragment that identifies this principal in a Policy.

`principalAccount`^Optional

Deprecated: use SamlPrincipal from aws-cdk-lib/aws-iam

public readonly principalAccount: string;

Type: string

The AWS account ID of this principal.

Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it's assumed to be AWS::AccountId.

`conditions`^Required

Deprecated: use SamlPrincipal from aws-cdk-lib/aws-iam

public readonly conditions: {[ key: string ]: any};

Type: {[ key: string ]: any}

The conditions under which the policy is in effect.

https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html

`federated`^Required

Deprecated: use SamlPrincipal from aws-cdk-lib/aws-iam

public readonly federated: string;

Type: string

federated identity provider (i.e. 'cognito-identity.amazonaws.com' for users authenticated through Cognito).

SlackAppManifest

A Slack app manifest.

https://api.slack.com/reference/manifests

Initializers

import { SlackAppManifest } from 'cloudstructs'

new SlackAppManifest(props: SlackAppManifestProps)

Name	Type	Description
`props`	`SlackAppManifestProps`	No description.

`props`^Required

Type: SlackAppManifestProps

Methods

Name	Description
`render`	No description.

`render`

public render(construct: IConstruct): string

`construct`^Required

Type: constructs.IConstruct

SlackAppManifestDefinition

A Slack app manifest definition.

Initializers

import { SlackAppManifestDefinition } from 'cloudstructs'

new SlackAppManifestDefinition()

Name	Type	Description

Methods

Name	Description
`render`	Renders the JSON app manifest encoded as a string.

`render`

public render(construct: IConstruct): string

Renders the JSON app manifest encoded as a string.

`construct`^Required

Type: constructs.IConstruct

Static Functions

Name	Description
`fromFile`	Creates a Slack app manifest from a file containg a JSON app manifest.
`fromManifest`	Creates a Slack app manifest by specifying properties.
`fromString`	Create a Slack app manifest from a JSON app manifest encoded as a string.

`fromFile`

import { SlackAppManifestDefinition } from 'cloudstructs'

SlackAppManifestDefinition.fromFile(file: string)

Creates a Slack app manifest from a file containg a JSON app manifest.

`file`^Required

Type: string

`fromManifest`

import { SlackAppManifestDefinition } from 'cloudstructs'

SlackAppManifestDefinition.fromManifest(props: SlackAppManifestProps)

Creates a Slack app manifest by specifying properties.

`props`^Required

Type: SlackAppManifestProps

`fromString`

import { SlackAppManifestDefinition } from 'cloudstructs'

SlackAppManifestDefinition.fromString(manifest: string)

Create a Slack app manifest from a JSON app manifest encoded as a string.

`manifest`^Required

Type: string

Protocols

IStateMachine

Implemented By: IStateMachine

A State Machine.

Properties

Name	Type	Description
`stateMachineArn`	`string`	The ARN of the state machine.

`stateMachineArn`^Required

public readonly stateMachineArn: string;

Type: string

The ARN of the state machine.

Enums

DmarcAlignment

The DMARC alignment mode.

Members

Name	Description
`RELAXED`	Relaxed alignment mode.
`STRICT`	Strict alignment mode.

`RELAXED`

Relaxed alignment mode.

`STRICT`

Strict alignment mode.

DmarcPolicy

The DMARC policy to apply to messages that fail DMARC compliance.

Members

Name	Description
`NONE`	Do not apply any special handling to messages that fail DMARC compliance.
`QUARANTINE`	Quarantine messages that fail DMARC compliance.
`REJECT`	Reject messages that fail DMARC compliance.

`NONE`

Do not apply any special handling to messages that fail DMARC compliance.

`QUARANTINE`

Quarantine messages that fail DMARC compliance.

(usually by sending them to spam)

`REJECT`

Reject messages that fail DMARC compliance.

(usually by rejecting them outright)

SlackAppManifestShortcutType

Type of shortcuts.

https://api.slack.com/interactivity/shortcuts

Members

Name	Description
`MESSAGE`	Message shortcuts are shown to users in the context menus of messages within Slack.
`GLOBAL`	Global shortcuts are available to users via the shortcuts button in the composer, and when using search in Slack.

`MESSAGE`

Message shortcuts are shown to users in the context menus of messages within Slack.

https://api.slack.com/interactivity/shortcuts/using#message_shortcuts

`GLOBAL`

Global shortcuts are available to users via the shortcuts button in the composer, and when using search in Slack.

https://api.slack.com/interactivity/shortcuts/using#global_shortcuts

SslServerTestGrade

SSL Server test grade.

Members

Name	Description
`A_PLUS`	No description.
`A`	No description.
`A_MINUS`	No description.
`B`	No description.
`C`	No description.
`D`	No description.
`E`	No description.
`F`	No description.

Files

API.md

Latest commit

History

API.md

File metadata and controls

API Reference

Constructs

CodeCommitMirror

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

Static Functions

isConstruct

xRequired

Properties

nodeRequired

DmarcReporter

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

Static Functions

isConstruct

xRequired

Properties

nodeRequired

EcsServiceRoller

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

Static Functions

isConstruct

xRequired

Properties

nodeRequired

EmailReceiver

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

Static Functions

isConstruct

xRequired

Properties

nodeRequired

bucketRequired

topicRequired

MjmlTemplate

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

Static Functions

isConstruct

xRequired

Properties

nodeRequired

templateNameRequired

SamlIdentityProvider

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

Static Functions

isConstruct

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`bucket`^Required

`topic`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`templateName`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`samlIdentityProviderArn`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`appId`^Required

`clientId`^Required

`clientSecret`^Required

`credentials`^Required

`signingSecret`^Required

`verificationToken`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`eventBus`^Optional

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required