API Reference

Constructs

BashJobOrchestrator

Provides a BashJobOrchestrator to execute a BashJobRunner.

Initializers

import { BashJobOrchestrator } from '@cdklabs/sbt-aws'

new BashJobOrchestrator(scope: Construct, id: string, props: BashJobOrchestratorProps)

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

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: BashJobOrchestratorProps

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 { BashJobOrchestrator } from '@cdklabs/sbt-aws'

BashJobOrchestrator.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.
`eventTarget`	`aws-cdk-lib.aws_events.IRuleTarget`	The eventTarget to use when triggering this BashJobOrchestrator.
`provisioningStateMachine`	`aws-cdk-lib.aws_stepfunctions.StateMachine`	The StateMachine used to implement this BashJobOrchestrator.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`eventTarget`^Required

public readonly eventTarget: IRuleTarget;

Type: aws-cdk-lib.aws_events.IRuleTarget

The eventTarget to use when triggering this BashJobOrchestrator.

`provisioningStateMachine`^Required

public readonly provisioningStateMachine: StateMachine;

Type: aws-cdk-lib.aws_stepfunctions.StateMachine

The StateMachine used to implement this BashJobOrchestrator.

BashJobRunner

Provides a BashJobRunner to execute arbitrary bash code.

Initializers

import { BashJobRunner } from '@cdklabs/sbt-aws'

new BashJobRunner(scope: Construct, id: string, props: BashJobRunnerProps)

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

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: BashJobRunnerProps

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 { BashJobRunner } from '@cdklabs/sbt-aws'

BashJobRunner.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.
`codebuildProject`	`aws-cdk-lib.aws_codebuild.Project`	The codebuildProject used to implement this BashJobRunner.
`eventTarget`	`aws-cdk-lib.aws_events.IRuleTarget`	The eventTarget to use when triggering this BashJobRunner.
`environmentVariablesToOutgoingEvent`	`string[]`	The environment variables to export into the outgoing event once the BashJobRunner has finished.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`codebuildProject`^Required

public readonly codebuildProject: Project;

Type: aws-cdk-lib.aws_codebuild.Project

The codebuildProject used to implement this BashJobRunner.

`eventTarget`^Required

public readonly eventTarget: IRuleTarget;

Type: aws-cdk-lib.aws_events.IRuleTarget

The eventTarget to use when triggering this BashJobRunner.

`environmentVariablesToOutgoingEvent`^Optional

public readonly environmentVariablesToOutgoingEvent: string[];

Type: string[]

The environment variables to export into the outgoing event once the BashJobRunner has finished.

BillingProvider

Represents a Billing Provider that handles billing-related operations.

This construct sets up event targets for various billing-related events and optionally creates an API Gateway resource for a webhook function.

Initializers

import { BillingProvider } from '@cdklabs/sbt-aws'

new BillingProvider(scope: Construct, id: string, props: BillingProviderProps)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The unique ID of this construct.
`props`	`BillingProviderProps`	The properties for the BillingProvider.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The unique ID of this construct.

`props`^Required

Type: BillingProviderProps

The properties for the BillingProvider.

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 { BillingProvider } from '@cdklabs/sbt-aws'

BillingProvider.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.
`controlPlaneAPIBillingWebhookResource`	`aws-cdk-lib.aws_apigateway.IResource`	The API Gateway resource containing the billing webhook resource.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`controlPlaneAPIBillingWebhookResource`^Optional

public readonly controlPlaneAPIBillingWebhookResource: IResource;

Type: aws-cdk-lib.aws_apigateway.IResource

The API Gateway resource containing the billing webhook resource.

Only set when the IBilling webhookFunction is defined.

CognitoAuth

Implements: IAuth

Constructs for setting up Cognito authentication and user management.

Initializers

import { CognitoAuth } from '@cdklabs/sbt-aws'

new CognitoAuth(scope: Construct, id: string, props: CognitoAuthProps)

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

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: CognitoAuthProps

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 { CognitoAuth } from '@cdklabs/sbt-aws'

CognitoAuth.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.
`authorizationServer`	`string`	The authorization server for the control plane IdP.
`authorizer`	`aws-cdk-lib.aws_apigateway.IAuthorizer`	The API Gateway authorizer for authenticating requests.
`clientId`	`string`	The client ID for the control plane IdP.
`controlPlaneIdpDetails`	`any`	The details of the control plane Identity Provider (IdP).
`createUserFunction`	`aws-cdk-lib.aws_lambda.IFunction`	The Lambda function for creating a user.
`deleteUserFunction`	`aws-cdk-lib.aws_lambda.IFunction`	The Lambda function for deleting a user.
`disableUserFunction`	`aws-cdk-lib.aws_lambda.IFunction`	The Lambda function for disabling a user.
`enableUserFunction`	`aws-cdk-lib.aws_lambda.IFunction`	The Lambda function for enabling a user.
`fetchAllUsersFunction`	`aws-cdk-lib.aws_lambda.IFunction`	The Lambda function for fetching all users.
`fetchUserFunction`	`aws-cdk-lib.aws_lambda.IFunction`	The Lambda function for fetching a user.
`updateUserFunction`	`aws-cdk-lib.aws_lambda.IFunction`	The Lambda function for updating a user.
`wellKnownEndpointUrl`	`string`	The well-known endpoint URL for the control plane IdP.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`authorizationServer`^Required

public readonly authorizationServer: string;

Type: string

The authorization server for the control plane IdP.

`authorizer`^Required

public readonly authorizer: IAuthorizer;

Type: aws-cdk-lib.aws_apigateway.IAuthorizer

The API Gateway authorizer for authenticating requests.

`clientId`^Required

public readonly clientId: string;

Type: string

The client ID for the control plane IdP.

`controlPlaneIdpDetails`^Required

public readonly controlPlaneIdpDetails: any;

Type: any

The details of the control plane Identity Provider (IdP).

`createUserFunction`^Required

public readonly createUserFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

The Lambda function for creating a user.

`deleteUserFunction`^Required

public readonly deleteUserFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

The Lambda function for deleting a user.

`disableUserFunction`^Required

public readonly disableUserFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

The Lambda function for disabling a user.

`enableUserFunction`^Required

public readonly enableUserFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

The Lambda function for enabling a user.

`fetchAllUsersFunction`^Required

public readonly fetchAllUsersFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

The Lambda function for fetching all users.

`fetchUserFunction`^Required

public readonly fetchUserFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

The Lambda function for fetching a user.

`updateUserFunction`^Required

public readonly updateUserFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

The Lambda function for updating a user.

`wellKnownEndpointUrl`^Required

public readonly wellKnownEndpointUrl: string;

Type: string

The well-known endpoint URL for the control plane IdP.

ControlPlane

Initializers

import { ControlPlane } from '@cdklabs/sbt-aws'

new ControlPlane(scope: Construct, id: string, props: ControlPlaneProps)

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

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: ControlPlaneProps

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 { ControlPlane } from '@cdklabs/sbt-aws'

ControlPlane.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.
`controlPlaneAPIGatewayUrl`	`string`	The URL of the control plane API Gateway.
`eventManager`	`IEventManager`	The EventManager instance that allows connecting to events flowing between the Control Plane and other components.
`tables`	`Tables`	The Tables instance containing the DynamoDB tables for tenant data and configurations.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`controlPlaneAPIGatewayUrl`^Required

public readonly controlPlaneAPIGatewayUrl: string;

Type: string

The URL of the control plane API Gateway.

`eventManager`^Required

public readonly eventManager: IEventManager;

Type: IEventManager

The EventManager instance that allows connecting to events flowing between the Control Plane and other components.

`tables`^Required

public readonly tables: Tables;

Type: Tables

The Tables instance containing the DynamoDB tables for tenant data and configurations.

ControlPlaneAPI

Initializers

import { ControlPlaneAPI } from '@cdklabs/sbt-aws'

new ControlPlaneAPI(scope: Construct, id: string, props: ControlPlaneAPIProps)

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

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: ControlPlaneAPIProps

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 { ControlPlaneAPI } from '@cdklabs/sbt-aws'

ControlPlaneAPI.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.
`billingResource`	`aws-cdk-lib.aws_apigateway.Resource`	No description.
`tenantUpdateServiceTarget`	`aws-cdk-lib.aws_events_targets.ApiGateway`	No description.
`apiUrl`	`any`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`billingResource`^Required

public readonly billingResource: Resource;

Type: aws-cdk-lib.aws_apigateway.Resource

`tenantUpdateServiceTarget`^Required

public readonly tenantUpdateServiceTarget: ApiGateway;

Type: aws-cdk-lib.aws_events_targets.ApiGateway

`apiUrl`^Required

public readonly apiUrl: any;

Type: any

CoreApplicationPlane

Provides a CoreApplicationPlane.

This construct will help create resources to accelerate building an SBT-compliant Application Plane. It can be configured to attach itself to the EventBus created by the SBT Control Plane and listen to and respond to events created by the control plane.

Initializers

import { CoreApplicationPlane } from '@cdklabs/sbt-aws'

new CoreApplicationPlane(scope: Construct, id: string, props: CoreApplicationPlaneProps)

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

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: CoreApplicationPlaneProps

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 { CoreApplicationPlane } from '@cdklabs/sbt-aws'

CoreApplicationPlane.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.
`eventManager`	`IEventManager`	The EventManager instance that allows connecting to events flowing between the Control Plane and other components.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`eventManager`^Required

public readonly eventManager: IEventManager;

Type: IEventManager

The EventManager instance that allows connecting to events flowing between the Control Plane and other components.

EventManager

Implements: IEventManager

Provides an EventManager to interact with the EventBus shared with the SBT control plane.

Initializers

import { EventManager } from '@cdklabs/sbt-aws'

new EventManager(scope: Construct, id: string, props?: EventManagerProps)

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

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Optional

Type: EventManagerProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addTargetToEvent`	Adds an IRuleTarget to an event.
`grantPutEventsTo`	Provides grantee the permissions to place events on the EventManager bus.

`toString`

public toString(): string

Returns a string representation of this construct.

`addTargetToEvent`

public addTargetToEvent(eventType: DetailType, target: IRuleTarget): void

Adds an IRuleTarget to an event.

`eventType`^Required

Type: DetailType

The detail type of the event to add a target to.

`target`^Required

Type: aws-cdk-lib.aws_events.IRuleTarget

The target that will be added to the event.

`grantPutEventsTo`

public grantPutEventsTo(grantee: IGrantable): void

Provides grantee the permissions to place events on the EventManager bus.

`grantee`^Required

Type: aws-cdk-lib.aws_iam.IGrantable

The grantee resource that will be granted the permission(s).

Static Functions

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

`isConstruct`

import { EventManager } from '@cdklabs/sbt-aws'

EventManager.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.
`applicationPlaneEventSource`	`string`	The event source used for events emitted by the application plane.
`busArn`	`string`	The ARN/ID of the bus that will be used to send and receive events.
`busName`	`string`	The name of the bus that will be used to send and receive events.
`controlPlaneEventSource`	`string`	The event source used for events emitted by the control plane.
`eventBus`	`aws-cdk-lib.aws_events.IEventBus`	The eventBus resource that will be used to send and receive events.
`supportedEvents`	`{[ key: string ]: string}`	List of recognized events that are available as triggers.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`applicationPlaneEventSource`^Required

public readonly applicationPlaneEventSource: string;

Type: string

The event source used for events emitted by the application plane.

`busArn`^Required

public readonly busArn: string;

Type: string

The ARN/ID of the bus that will be used to send and receive events.

`busName`^Required

public readonly busName: string;

Type: string

The name of the bus that will be used to send and receive events.

`controlPlaneEventSource`^Required

public readonly controlPlaneEventSource: string;

Type: string

The event source used for events emitted by the control plane.

`eventBus`^Required

public readonly eventBus: IEventBus;

Type: aws-cdk-lib.aws_events.IEventBus

The eventBus resource that will be used to send and receive events.

`supportedEvents`^Required

public readonly supportedEvents: {[ key: string ]: string};

Type: {[ key: string ]: string}

List of recognized events that are available as triggers.

FirehoseAggregator

Implements: IDataIngestorAggregator

Creates a Kinesis Firehose to accept high-volume data, which it then routes to an s3 bucket.

The s3 bucket triggers a lambda which processes the data and stores it in a DynamoDB table containing the aggregated data.

Initializers

import { FirehoseAggregator } from '@cdklabs/sbt-aws'

new FirehoseAggregator(scope: Construct, id: string, props: FirehoseAggregatorProps)

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

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: FirehoseAggregatorProps

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 { FirehoseAggregator } from '@cdklabs/sbt-aws'

FirehoseAggregator.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.
`dataAggregator`	`aws-cdk-lib.aws_lambda.IFunction`	The Python Lambda function responsible for aggregating the raw data coming in via the dataIngestor.
`dataIngestor`	`@aws-cdk/aws-kinesisfirehose-alpha.DeliveryStream`	The Firehose DeliveryStream ingestor responsible for accepting the incoming data.
`dataIngestorName`	`string`	The name of the dataIngestor.
`dataRepository`	`aws-cdk-lib.aws_dynamodb.ITable`	The DynamoDB table containing the aggregated data.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`dataAggregator`^Required

public readonly dataAggregator: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

The Python Lambda function responsible for aggregating the raw data coming in via the dataIngestor.

`dataIngestor`^Required

public readonly dataIngestor: DeliveryStream;

Type: @aws-cdk/aws-kinesisfirehose-alpha.DeliveryStream

The Firehose DeliveryStream ingestor responsible for accepting the incoming data.

`dataIngestorName`^Required

public readonly dataIngestorName: string;

Type: string

The name of the dataIngestor.

This is used for visibility.

`dataRepository`^Required

public readonly dataRepository: ITable;

Type: aws-cdk-lib.aws_dynamodb.ITable

The DynamoDB table containing the aggregated data.

Services

Initializers

import { Services } from '@cdklabs/sbt-aws'

new Services(scope: Construct, id: string, props: ServicesProps)

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

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: ServicesProps

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 { Services } from '@cdklabs/sbt-aws'

Services.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.
`tenantManagementServices`	`aws-cdk-lib.aws_lambda.Function`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`tenantManagementServices`^Required

public readonly tenantManagementServices: Function;

Type: aws-cdk-lib.aws_lambda.Function

Tables

Initializers

import { Tables } from '@cdklabs/sbt-aws'

new Tables(scope: Construct, id: string)

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

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

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 { Tables } from '@cdklabs/sbt-aws'

Tables.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.
`tenantConfigColumn`	`string`	No description.
`tenantConfigIndexName`	`string`	No description.
`tenantDetails`	`aws-cdk-lib.aws_dynamodb.Table`	No description.
`tenantIdColumn`	`string`	No description.
`tenantNameColumn`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`tenantConfigColumn`^Required

public readonly tenantConfigColumn: string;

Type: string

`tenantConfigIndexName`^Required

public readonly tenantConfigIndexName: string;

Type: string

`tenantDetails`^Required

public readonly tenantDetails: Table;

Type: aws-cdk-lib.aws_dynamodb.Table

`tenantIdColumn`^Required

public readonly tenantIdColumn: string;

Type: string

`tenantNameColumn`^Required

public readonly tenantNameColumn: string;

Type: string

TenantConfigService

Initializers

import { TenantConfigService } from '@cdklabs/sbt-aws'

new TenantConfigService(scope: Construct, id: string, props: TenantConfigServiceProps)

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

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: TenantConfigServiceProps

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 { TenantConfigService } from '@cdklabs/sbt-aws'

TenantConfigService.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.
`tenantConfigServiceLambda`	`aws-cdk-lib.aws_lambda.Function`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`tenantConfigServiceLambda`^Required

public readonly tenantConfigServiceLambda: Function;

Type: aws-cdk-lib.aws_lambda.Function

Structs

BashJobOrchestratorProps

Encapsulates the list of properties for a BashJobOrchestrator.

Initializer

import { BashJobOrchestratorProps } from '@cdklabs/sbt-aws'

const bashJobOrchestratorProps: BashJobOrchestratorProps = { ... }

Properties

Name	Type	Description
`analyticsReporting`	`boolean`	Include runtime versioning information in this Stack.
`crossRegionReferences`	`boolean`	Enable this flag to allow native cross region stack references.
`description`	`string`	A description of the stack.
`env`	`aws-cdk-lib.Environment`	The AWS environment (account/region) where this stack will be deployed.
`permissionsBoundary`	`aws-cdk-lib.PermissionsBoundary`	Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.
`stackName`	`string`	Name to deploy the stack with.
`suppressTemplateIndentation`	`boolean`	Enable this flag to suppress indentation in generated CloudFormation templates.
`synthesizer`	`aws-cdk-lib.IStackSynthesizer`	Synthesis method to use while deploying this stack.
`tags`	`{[ key: string ]: string}`	Stack tags that will be applied to all the taggable resources and the stack itself.
`terminationProtection`	`boolean`	Whether to enable termination protection for this stack.
`bashJobRunner`	`BashJobRunner`	The BashJobRunner to execute as part of this BashJobOrchestrator.
`detailType`	`string`	The detail type to use when publishing event bridge events.
`eventSource`	`string`	The event source to use when publishing event bridge events.
`targetEventBus`	`aws-cdk-lib.aws_events.IEventBus`	The event bus to publish the outgoing event to.
`environmentJSONVariablesFromIncomingEvent`	`string[]`	No description.
`environmentStringVariablesFromIncomingEvent`	`string[]`	Environment variables to import into the bash job from event details field.
`environmentVariablesToOutgoingEvent`	`string[]`	Environment variables to export into the outgoing event once the bash job has finished.

`analyticsReporting`^Optional

public readonly analyticsReporting: boolean;

Type: boolean
Default: analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

Include runtime versioning information in this Stack.

`crossRegionReferences`^Optional

public readonly crossRegionReferences: boolean;

Type: boolean
Default: false

Enable this flag to allow native cross region stack references.

Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

This feature is currently experimental

`description`^Optional

public readonly description: string;

Type: string
Default: No description.

A description of the stack.

`env`^Optional

public readonly env: Environment;

Type: aws-cdk-lib.Environment
Default: The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.

The AWS environment (account/region) where this stack will be deployed.

Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).

If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

If either region or account are not set nor inherited from Stage, the Stack will be considered "environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

Example

// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  },
});

// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT,
    region: process.env.CDK_DEFAULT_REGION
  },
});

// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  }
});

// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');

// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');

`permissionsBoundary`^Optional

public readonly permissionsBoundary: PermissionsBoundary;

Type: aws-cdk-lib.PermissionsBoundary
Default: no permissions boundary is applied

Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.

`stackName`^Optional

public readonly stackName: string;

Type: string
Default: Derived from construct path.

Name to deploy the stack with.

`suppressTemplateIndentation`^Optional

public readonly suppressTemplateIndentation: boolean;

Type: boolean
Default: the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.

Enable this flag to suppress indentation in generated CloudFormation templates.

If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

`synthesizer`^Optional

public readonly synthesizer: IStackSynthesizer;

Type: aws-cdk-lib.IStackSynthesizer
Default: The synthesizer specified on App, or DefaultStackSynthesizer otherwise.

Synthesis method to use while deploying this stack.

The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

If not specified, the defaultStackSynthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

`tags`^Optional

public readonly tags: {[ key: string ]: string};

Type: {[ key: string ]: string}
Default: {}

Stack tags that will be applied to all the taggable resources and the stack itself.

`terminationProtection`^Optional

public readonly terminationProtection: boolean;

Type: boolean
Default: false

Whether to enable termination protection for this stack.

`bashJobRunner`^Required

public readonly bashJobRunner: BashJobRunner;

Type: BashJobRunner

The BashJobRunner to execute as part of this BashJobOrchestrator.

`detailType`^Required

public readonly detailType: string;

Type: string

The detail type to use when publishing event bridge events.

`eventSource`^Required

public readonly eventSource: string;

Type: string

The event source to use when publishing event bridge events.

`targetEventBus`^Required

public readonly targetEventBus: IEventBus;

Type: aws-cdk-lib.aws_events.IEventBus

The event bus to publish the outgoing event to.

`environmentJSONVariablesFromIncomingEvent`^Optional

public readonly environmentJSONVariablesFromIncomingEvent: string[];

Type: string[]

`environmentStringVariablesFromIncomingEvent`^Optional

public readonly environmentStringVariablesFromIncomingEvent: string[];

Type: string[]

Environment variables to import into the bash job from event details field.

`environmentVariablesToOutgoingEvent`^Optional

public readonly environmentVariablesToOutgoingEvent: string[];

Type: string[]

Environment variables to export into the outgoing event once the bash job has finished.

BashJobRunnerProps

Encapsulates the list of properties for a BashJobRunner.

Initializer

import { BashJobRunnerProps } from '@cdklabs/sbt-aws'

const bashJobRunnerProps: BashJobRunnerProps = { ... }

Properties

Name	Type	Description
`name`	`string`	The name of the BashJobRunner.
`permissions`	`aws-cdk-lib.aws_iam.PolicyDocument`	The IAM permission document for the BashJobRunner.
`script`	`string`	The bash script to run as part of the BashJobRunner.
`environmentVariablesFromIncomingEvent`	`string[]`	The environment variables to import into the BashJobRunner from event details field.
`environmentVariablesToOutgoingEvent`	`string[]`	The environment variables to export into the outgoing event once the BashJobRunner has finished.
`postScript`	`string`	The bash script to run after the main script has completed.
`scriptEnvironmentVariables`	`{[ key: string ]: string}`	The variables to pass into the codebuild BashJobRunner.

`name`^Required

public readonly name: string;

Type: string

The name of the BashJobRunner.

Note that this value must be unique.

`permissions`^Required

public readonly permissions: PolicyDocument;

Type: aws-cdk-lib.aws_iam.PolicyDocument

The IAM permission document for the BashJobRunner.

`script`^Required

public readonly script: string;

Type: string

The bash script to run as part of the BashJobRunner.

`environmentVariablesFromIncomingEvent`^Optional

public readonly environmentVariablesFromIncomingEvent: string[];

Type: string[]

The environment variables to import into the BashJobRunner from event details field.

`environmentVariablesToOutgoingEvent`^Optional

public readonly environmentVariablesToOutgoingEvent: string[];

Type: string[]

The environment variables to export into the outgoing event once the BashJobRunner has finished.

`postScript`^Optional

public readonly postScript: string;

Type: string

The bash script to run after the main script has completed.

`scriptEnvironmentVariables`^Optional

public readonly scriptEnvironmentVariables: {[ key: string ]: string};

Type: {[ key: string ]: string}

The variables to pass into the codebuild BashJobRunner.

BillingProviderProps

Encapsulates the list of properties for a BillingProvider.

Initializer

import { BillingProviderProps } from '@cdklabs/sbt-aws'

const billingProviderProps: BillingProviderProps = { ... }

Properties

Name	Type	Description
`billing`	`IBilling`	An implementation of the IBilling interface.
`controlPlaneAPIBillingResource`	`aws-cdk-lib.aws_apigateway.IResource`	An API Gateway Resource for the BillingProvider to use when setting up API endpoints.
`eventManager`	`IEventManager`	An IEventManager object to help coordinate events.

`billing`^Required

public readonly billing: IBilling;

Type: IBilling

An implementation of the IBilling interface.

`controlPlaneAPIBillingResource`^Required

public readonly controlPlaneAPIBillingResource: IResource;

Type: aws-cdk-lib.aws_apigateway.IResource

An API Gateway Resource for the BillingProvider to use when setting up API endpoints.

`eventManager`^Required

public readonly eventManager: IEventManager;

Type: IEventManager

An IEventManager object to help coordinate events.

CognitoAuthProps

Properties for the CognitoAuth construct.

Initializer

import { CognitoAuthProps } from '@cdklabs/sbt-aws'

const cognitoAuthProps: CognitoAuthProps = { ... }

Properties

Name	Type	Description
`systemAdminEmail`	`string`	The email address of the system admin.
`controlPlaneCallbackURL`	`string`	The callback URL for the control plane.
`systemAdminRoleName`	`string`	The name of the system admin role.

`systemAdminEmail`^Required

public readonly systemAdminEmail: string;

Type: string

The email address of the system admin.

`controlPlaneCallbackURL`^Optional

public readonly controlPlaneCallbackURL: string;

Type: string
Default: 'http://localhost'

The callback URL for the control plane.

`systemAdminRoleName`^Optional

public readonly systemAdminRoleName: string;

Type: string
Default: 'SystemAdmin'

The name of the system admin role.

ControlPlaneAPIProps

Initializer

import { ControlPlaneAPIProps } from '@cdklabs/sbt-aws'

const controlPlaneAPIProps: ControlPlaneAPIProps = { ... }

Properties

Name	Type	Description
`auth`	`IAuth`	No description.
`services`	`Services`	No description.
`tenantConfigServiceLambda`	`aws-cdk-lib.aws_lambda.Function`	No description.
`disableAPILogging`	`boolean`	No description.

`auth`^Required

public readonly auth: IAuth;

Type: IAuth

`services`^Required

public readonly services: Services;

Type: Services

`tenantConfigServiceLambda`^Required

public readonly tenantConfigServiceLambda: Function;

Type: aws-cdk-lib.aws_lambda.Function

`disableAPILogging`^Optional

public readonly disableAPILogging: boolean;

Type: boolean

ControlPlaneProps

Initializer

import { ControlPlaneProps } from '@cdklabs/sbt-aws'

const controlPlaneProps: ControlPlaneProps = { ... }

Properties

Name	Type	Description
`auth`	`IAuth`	The authentication provider for the control plane.
`billing`	`IBilling`	The billing provider configuration.
`disableAPILogging`	`boolean`	If true, the API Gateway will not log requests to the CloudWatch Logs.
`eventManager`	`IEventManager`	The event manager instance.

`auth`^Required

public readonly auth: IAuth;

Type: IAuth

The authentication provider for the control plane.

`billing`^Optional

public readonly billing: IBilling;

Type: IBilling

The billing provider configuration.

`disableAPILogging`^Optional

public readonly disableAPILogging: boolean;

Type: boolean
Default: false

If true, the API Gateway will not log requests to the CloudWatch Logs.

`eventManager`^Optional

public readonly eventManager: IEventManager;

Type: IEventManager

The event manager instance.

If not provided, a new instance will be created.

CoreApplicationPlaneJobRunnerProps

Encapsulates the list of properties for a CoreApplicationPlaneJobRunner.

Initializer

import { CoreApplicationPlaneJobRunnerProps } from '@cdklabs/sbt-aws'

const coreApplicationPlaneJobRunnerProps: CoreApplicationPlaneJobRunnerProps = { ... }

Properties

Name	Type	Description
`incomingEvent`	`DetailType`	The incoming event DetailType that triggers this job.
`name`	`string`	The name of the CoreApplicationPlaneJobRunner.
`outgoingEvent`	`DetailType`	The outgoing event DetailType that is emitted upon job completion.
`permissions`	`aws-cdk-lib.aws_iam.PolicyDocument`	The IAM permission document for the CoreApplicationPlaneJobRunner.
`script`	`string`	The bash script to run as part of the CoreApplicationPlaneJobRunner.
`environmentJSONVariablesFromIncomingEvent`	`string[]`	The environment variables to import into the CoreApplicationPlaneJobRunner from event details field.
`environmentStringVariablesFromIncomingEvent`	`string[]`	The environment variables to import into the CoreApplicationPlaneJobRunner from event details field.
`environmentVariablesToOutgoingEvent`	`string[]`	The environment variables to export into the outgoing event once the CoreApplicationPlaneJobRunner has finished.
`postScript`	`string`	The bash script to run after the main script has completed.
`scriptEnvironmentVariables`	`{[ key: string ]: string}`	The variables to pass into the codebuild CoreApplicationPlaneJobRunner.

`incomingEvent`^Required

public readonly incomingEvent: DetailType;

Type: DetailType

The incoming event DetailType that triggers this job.

`name`^Required

public readonly name: string;

Type: string

The name of the CoreApplicationPlaneJobRunner.

Note that this value must be unique.

`outgoingEvent`^Required

public readonly outgoingEvent: DetailType;

Type: DetailType

The outgoing event DetailType that is emitted upon job completion.

`permissions`^Required

public readonly permissions: PolicyDocument;

Type: aws-cdk-lib.aws_iam.PolicyDocument

The IAM permission document for the CoreApplicationPlaneJobRunner.

`script`^Required

public readonly script: string;

Type: string

The bash script to run as part of the CoreApplicationPlaneJobRunner.

`environmentJSONVariablesFromIncomingEvent`^Optional

public readonly environmentJSONVariablesFromIncomingEvent: string[];

Type: string[]

The environment variables to import into the CoreApplicationPlaneJobRunner from event details field.

This argument consists of the names of only JSON-formatted string type variables. Ex. '{"test": 2}'

`environmentStringVariablesFromIncomingEvent`^Optional

public readonly environmentStringVariablesFromIncomingEvent: string[];

Type: string[]

The environment variables to import into the CoreApplicationPlaneJobRunner from event details field.

This argument consists of the names of only string type variables. Ex. 'test'

`environmentVariablesToOutgoingEvent`^Optional

public readonly environmentVariablesToOutgoingEvent: string[];

Type: string[]

The environment variables to export into the outgoing event once the CoreApplicationPlaneJobRunner has finished.

`postScript`^Optional

public readonly postScript: string;

Type: string

The bash script to run after the main script has completed.

`scriptEnvironmentVariables`^Optional

public readonly scriptEnvironmentVariables: {[ key: string ]: string};

Type: {[ key: string ]: string}

The variables to pass into the codebuild CoreApplicationPlaneJobRunner.

CoreApplicationPlaneProps

Encapsulates the list of properties for a CoreApplicationPlane.

Initializer

import { CoreApplicationPlaneProps } from '@cdklabs/sbt-aws'

const coreApplicationPlaneProps: CoreApplicationPlaneProps = { ... }

Properties

Name	Type	Description
`eventManager`	`IEventManager`	No description.
`jobRunnerPropsList`	`CoreApplicationPlaneJobRunnerProps[]`	The list of JobRunner definitions to create.

`eventManager`^Optional

public readonly eventManager: IEventManager;

Type: IEventManager

`jobRunnerPropsList`^Optional

public readonly jobRunnerPropsList: CoreApplicationPlaneJobRunnerProps[];

Type: CoreApplicationPlaneJobRunnerProps[]

The list of JobRunner definitions to create.

EventManagerProps

Encapsulates the properties for an EventManager.

Initializer

import { EventManagerProps } from '@cdklabs/sbt-aws'

const eventManagerProps: EventManagerProps = { ... }

Properties

Name	Type	Description
`applicationPlaneEventSource`	`string`	The name of the event source for events coming from the SBT application plane.
`controlPlaneEventSource`	`string`	The name of the event source for events coming from the SBT control plane.
`eventBus`	`aws-cdk-lib.aws_events.IEventBus`	The event bus to register new rules with.
`eventMetadata`	`{[ key: string ]: string}`	The EventMetadata to use to update the event defaults.

`applicationPlaneEventSource`^Optional

public readonly applicationPlaneEventSource: string;

Type: string

The name of the event source for events coming from the SBT application plane.

`controlPlaneEventSource`^Optional

public readonly controlPlaneEventSource: string;

Type: string

The name of the event source for events coming from the SBT control plane.

`eventBus`^Optional

public readonly eventBus: IEventBus;

Type: aws-cdk-lib.aws_events.IEventBus

The event bus to register new rules with.

One will be created if not provided.

`eventMetadata`^Optional

public readonly eventMetadata: {[ key: string ]: string};

Type: {[ key: string ]: string}

The EventMetadata to use to update the event defaults.

FirehoseAggregatorProps

Encapsulates the list of properties for a FirehoseAggregator construct.

Initializer

import { FirehoseAggregatorProps } from '@cdklabs/sbt-aws'

const firehoseAggregatorProps: FirehoseAggregatorProps = { ... }

Properties

Name	Type	Description
`aggregateKeyPath`	`string`	The JMESPath to find the key value in the incoming data stream that will be aggregated.
`aggregateValuePath`	`string`	The JMESPath to find the numeric value of key in the incoming data stream that will be aggregated.
`primaryKeyColumn`	`string`	The name to use for the primary key column for the dynamoDB database.
`primaryKeyPath`	`string`	The JMESPath to find the primary key value in the incoming data stream.

`aggregateKeyPath`^Required

public readonly aggregateKeyPath: string;

Type: string

The JMESPath to find the key value in the incoming data stream that will be aggregated.

`aggregateValuePath`^Required

public readonly aggregateValuePath: string;

Type: string

The JMESPath to find the numeric value of key in the incoming data stream that will be aggregated.

`primaryKeyColumn`^Required

public readonly primaryKeyColumn: string;

Type: string

The name to use for the primary key column for the dynamoDB database.

`primaryKeyPath`^Required

public readonly primaryKeyPath: string;

Type: string

The JMESPath to find the primary key value in the incoming data stream.

ServicesProps

Initializer

import { ServicesProps } from '@cdklabs/sbt-aws'

const servicesProps: ServicesProps = { ... }

Properties

Name	Type	Description
`eventManager`	`IEventManager`	No description.
`tables`	`Tables`	No description.

`eventManager`^Required

public readonly eventManager: IEventManager;

Type: IEventManager

`tables`^Required

public readonly tables: Tables;

Type: Tables

Tenant

Initializer

import { Tenant } from '@cdklabs/sbt-aws'

const tenant: Tenant = { ... }

Properties

Name	Type	Description
`adminEmail`	`string`	No description.
`adminUserName`	`string`	No description.
`callbackUrls`	`string[]`	No description.
`clientId`	`string`	No description.
`clientName`	`string`	No description.
`customDomainName`	`string`	No description.
`groupName`	`string`	No description.
`id`	`string`	No description.
`idpDetails`	`string`	No description.
`name`	`string`	No description.
`oidcClientId`	`string`	No description.
`oidcClientSecret`	`string`	No description.
`oidcIssuer`	`string`	No description.
`providerName`	`string`	No description.
`supportedIdentityProviders`	`string[]`	No description.
`tenantDomain`	`string`	No description.
`tier`	`string`	No description.
`uniqueName`	`string`	No description.

`adminEmail`^Optional

public readonly adminEmail: string;

Type: string

`adminUserName`^Optional

public readonly adminUserName: string;

Type: string

`callbackUrls`^Optional

public readonly callbackUrls: string[];

Type: string[]

`clientId`^Optional

public readonly clientId: string;

Type: string

`clientName`^Optional

public readonly clientName: string;

Type: string

`customDomainName`^Optional

public readonly customDomainName: string;

Type: string

`groupName`^Optional

public readonly groupName: string;

Type: string

`id`^Optional

public readonly id: string;

Type: string

`idpDetails`^Optional

public readonly idpDetails: string;

Type: string

`name`^Optional

public readonly name: string;

Type: string

`oidcClientId`^Optional

public readonly oidcClientId: string;

Type: string

`oidcClientSecret`^Optional

public readonly oidcClientSecret: string;

Type: string

`oidcIssuer`^Optional

public readonly oidcIssuer: string;

Type: string

`providerName`^Optional

public readonly providerName: string;

Type: string

`supportedIdentityProviders`^Optional

public readonly supportedIdentityProviders: string[];

Type: string[]

`tenantDomain`^Optional

public readonly tenantDomain: string;

Type: string

`tier`^Optional

public readonly tier: string;

Type: string

`uniqueName`^Optional

public readonly uniqueName: string;

Type: string

TenantConfigServiceProps

Initializer

import { TenantConfigServiceProps } from '@cdklabs/sbt-aws'

const tenantConfigServiceProps: TenantConfigServiceProps = { ... }

Properties

Name	Type	Description
`tenantConfigIndexName`	`string`	No description.
`tenantDetails`	`aws-cdk-lib.aws_dynamodb.Table`	No description.
`tenantDetailsTenantConfigColumn`	`string`	No description.
`tenantDetailsTenantNameColumn`	`string`	No description.

`tenantConfigIndexName`^Required

public readonly tenantConfigIndexName: string;

Type: string

`tenantDetails`^Required

public readonly tenantDetails: Table;

Type: aws-cdk-lib.aws_dynamodb.Table

`tenantDetailsTenantConfigColumn`^Required

public readonly tenantDetailsTenantConfigColumn: string;

Type: string

`tenantDetailsTenantNameColumn`^Required

public readonly tenantDetailsTenantNameColumn: string;

Type: string

Protocols

IAuth

Implemented By: CognitoAuth, IAuth

Encapsulates the list of properties expected as outputs of Auth plugins.

Properties

Name	Type	Description
`authorizationServer`	`string`	Authorization server Url.
`authorizer`	`aws-cdk-lib.aws_apigateway.IAuthorizer`	Authorizer referenced by the ControlPlaneAPI.
`clientId`	`string`	The OAuth clientId for the identity provider.
`controlPlaneIdpDetails`	`any`	Contains any information relevant to the IDP implementation required by the Authorizer and User Function implementations.
`createUserFunction`	`aws-cdk-lib.aws_lambda.IFunction`	Function referenced by the ControlPlaneAPI -- POST /users.
`deleteUserFunction`	`aws-cdk-lib.aws_lambda.IFunction`	Function referenced by the ControlPlaneAPI -- DELETE /user/{username}.
`disableUserFunction`	`aws-cdk-lib.aws_lambda.IFunction`	Function referenced by the ControlPlaneAPI -- PUT /user/{username}/disable.
`enableUserFunction`	`aws-cdk-lib.aws_lambda.IFunction`	Function referenced by the ControlPlaneAPI -- PUT /user/{username}/enable.
`fetchAllUsersFunction`	`aws-cdk-lib.aws_lambda.IFunction`	Function referenced by the ControlPlaneAPI -- GET /users.
`fetchUserFunction`	`aws-cdk-lib.aws_lambda.IFunction`	Function referenced by the ControlPlaneAPI -- GET /user/{username}.
`updateUserFunction`	`aws-cdk-lib.aws_lambda.IFunction`	Function referenced by the ControlPlaneAPI -- PUT /user/{username}.
`wellKnownEndpointUrl`	`string`	OpenID configuration Url.

`authorizationServer`^Required

public readonly authorizationServer: string;

Type: string

Authorization server Url.

`authorizer`^Required

public readonly authorizer: IAuthorizer;

Type: aws-cdk-lib.aws_apigateway.IAuthorizer

Authorizer referenced by the ControlPlaneAPI.

`clientId`^Required

public readonly clientId: string;

Type: string

The OAuth clientId for the identity provider.

`controlPlaneIdpDetails`^Required

public readonly controlPlaneIdpDetails: any;

Type: any

Contains any information relevant to the IDP implementation required by the Authorizer and User Function implementations.

`createUserFunction`^Required

public readonly createUserFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

Function referenced by the ControlPlaneAPI -- POST /users.

`deleteUserFunction`^Required

public readonly deleteUserFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

Function referenced by the ControlPlaneAPI -- DELETE /user/{username}.

`disableUserFunction`^Required

public readonly disableUserFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

Function referenced by the ControlPlaneAPI -- PUT /user/{username}/disable.

`enableUserFunction`^Required

public readonly enableUserFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

Function referenced by the ControlPlaneAPI -- PUT /user/{username}/enable.

`fetchAllUsersFunction`^Required

public readonly fetchAllUsersFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

Function referenced by the ControlPlaneAPI -- GET /users.

`fetchUserFunction`^Required

public readonly fetchUserFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

Function referenced by the ControlPlaneAPI -- GET /user/{username}.

`updateUserFunction`^Required

public readonly updateUserFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

Function referenced by the ControlPlaneAPI -- PUT /user/{username}.

`wellKnownEndpointUrl`^Required

public readonly wellKnownEndpointUrl: string;

Type: string

OpenID configuration Url.

IBilling

Implemented By: IBilling

Encapsulates the list of properties for an IBilling construct.

Properties

Name	Type	Description
`createCustomerFunction`	`aws-cdk-lib.aws_lambda.IFunction \| IFunctionTrigger`	The function to trigger to create a new customer.
`deleteCustomerFunction`	`aws-cdk-lib.aws_lambda.IFunction \| IFunctionTrigger`	The function to trigger to delete a customer.
`createUserFunction`	`aws-cdk-lib.aws_lambda.IFunction \| IFunctionTrigger`	The function to trigger to create a new user.
`deleteUserFunction`	`aws-cdk-lib.aws_lambda.IFunction \| IFunctionTrigger`	The function to trigger to delete a user.
`ingestor`	`IDataIngestorAggregator`	The IDataIngestorAggregator responsible for accepting and aggregating the raw billing data.
`putUsageFunction`	`aws-cdk-lib.aws_lambda.IFunction \| IFunctionSchedule`	The function responsible for taking the aggregated data and pushing that to the billing provider.
`webhookFunction`	`aws-cdk-lib.aws_lambda.IFunction`	The function to trigger when a webhook request is received.
`webhookPath`	`string`	The path to the webhook resource.

`createCustomerFunction`^Required

public readonly createCustomerFunction: IFunction | IFunctionTrigger;

Type: aws-cdk-lib.aws_lambda.IFunction | IFunctionTrigger

The function to trigger to create a new customer.

(Customer in this context is an entity that has zero or more Users.)

`deleteCustomerFunction`^Required

public readonly deleteCustomerFunction: IFunction | IFunctionTrigger;

Type: aws-cdk-lib.aws_lambda.IFunction | IFunctionTrigger

The function to trigger to delete a customer.

(Customer in this context is an entity that has zero or more Users.)

`createUserFunction`^Optional

public readonly createUserFunction: IFunction | IFunctionTrigger;

Type: aws-cdk-lib.aws_lambda.IFunction | IFunctionTrigger

The function to trigger to create a new user.

(User in this context is an entity that belongs to a Customer.)

`deleteUserFunction`^Optional

public readonly deleteUserFunction: IFunction | IFunctionTrigger;

Type: aws-cdk-lib.aws_lambda.IFunction | IFunctionTrigger

The function to trigger to delete a user.

(User in this context is an entity that belongs to a Customer.)

`ingestor`^Optional

public readonly ingestor: IDataIngestorAggregator;

Type: IDataIngestorAggregator

The IDataIngestorAggregator responsible for accepting and aggregating the raw billing data.

`putUsageFunction`^Optional

public readonly putUsageFunction: IFunction | IFunctionSchedule;

Type: aws-cdk-lib.aws_lambda.IFunction | IFunctionSchedule

The function responsible for taking the aggregated data and pushing that to the billing provider.

`webhookFunction`^Optional

public readonly webhookFunction: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

The function to trigger when a webhook request is received.

`webhookPath`^Optional

public readonly webhookPath: string;

Type: string

The path to the webhook resource.

IDataIngestorAggregator

Implemented By: FirehoseAggregator, IDataIngestorAggregator

Encapsulates the list of properties for a IDataIngestorAggregator.

Properties

Name	Type	Description
`dataAggregator`	`aws-cdk-lib.aws_lambda.IFunction`	The function responsible for aggregating the raw data coming in via the dataIngestor.
`dataIngestorName`	`string`	The ingestor responsible for accepting and storing the incoming data.
`dataRepository`	`aws-cdk-lib.aws_dynamodb.ITable`	The table containing the aggregated data.

`dataAggregator`^Required

public readonly dataAggregator: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

The function responsible for aggregating the raw data coming in via the dataIngestor.

`dataIngestorName`^Required

public readonly dataIngestorName: string;

Type: string

The ingestor responsible for accepting and storing the incoming data.

`dataRepository`^Required

public readonly dataRepository: ITable;

Type: aws-cdk-lib.aws_dynamodb.ITable

The table containing the aggregated data.

IEventManager

Implemented By: EventManager, IEventManager

Methods

Name	Description
`addTargetToEvent`	Adds an IRuleTarget to an event.
`grantPutEventsTo`	Provides grantee the permissions to place events on the EventManager bus.

`addTargetToEvent`

public addTargetToEvent(eventType: DetailType, target: IRuleTarget): void

Adds an IRuleTarget to an event.

`eventType`^Required

Type: DetailType

The detail type of the event to add a target to.

`target`^Required

Type: aws-cdk-lib.aws_events.IRuleTarget

The target that will be added to the event.

`grantPutEventsTo`

public grantPutEventsTo(grantee: IGrantable): void

Provides grantee the permissions to place events on the EventManager bus.

`grantee`^Required

Type: aws-cdk-lib.aws_iam.IGrantable

The grantee resource that will be granted the permission(s).

Properties

Name	Type	Description
`applicationPlaneEventSource`	`string`	The event source used for events emitted by the application plane.
`busArn`	`string`	The ARN/ID of the bus that will be used to send and receive events.
`busName`	`string`	The name of the bus that will be used to send and receive events.
`controlPlaneEventSource`	`string`	The event source used for events emitted by the control plane.
`supportedEvents`	`{[ key: string ]: string}`	List of recognized events that are available as triggers.

`applicationPlaneEventSource`^Required

public readonly applicationPlaneEventSource: string;

Type: string

The event source used for events emitted by the application plane.

`busArn`^Required

public readonly busArn: string;

Type: string

The ARN/ID of the bus that will be used to send and receive events.

`busName`^Required

public readonly busName: string;

Type: string

The name of the bus that will be used to send and receive events.

`controlPlaneEventSource`^Required

public readonly controlPlaneEventSource: string;

Type: string

The event source used for events emitted by the control plane.

`supportedEvents`^Required

public readonly supportedEvents: {[ key: string ]: string};

Type: {[ key: string ]: string}

List of recognized events that are available as triggers.

IFunctionSchedule

Implemented By: IFunctionSchedule

Optional interface that allows specifying both the function to trigger and the schedule by which to trigger it.

Properties

Name	Type	Description
`handler`	`aws-cdk-lib.aws_lambda.IFunction`	The function definition.
`schedule`	`aws-cdk-lib.aws_events.Schedule`	The schedule that will trigger the handler function.

`handler`^Required

public readonly handler: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

The function definition.

`schedule`^Required

public readonly schedule: Schedule;

Type: aws-cdk-lib.aws_events.Schedule

The schedule that will trigger the handler function.

IFunctionTrigger

Implemented By: IFunctionTrigger

Optional interface that allows specifying both the function to trigger and the event that will trigger it.

Properties

Name	Type	Description
`handler`	`aws-cdk-lib.aws_lambda.IFunction`	The function definition.
`trigger`	`DetailType`	The detail-type that will trigger the handler function.

`handler`^Required

public readonly handler: IFunction;

Type: aws-cdk-lib.aws_lambda.IFunction

The function definition.

`trigger`^Required

public readonly trigger: DetailType;

Type: DetailType

The detail-type that will trigger the handler function.

Enums

DetailType

Provides an easy way of accessing event detail types.

The string values represent the "detail-type" used in events sent across the EventBus.

Members

Name	Description
`ONBOARDING_REQUEST`	Event detail type for onboarding request.
`ONBOARDING_SUCCESS`	Event detail type for successful onboarding.
`ONBOARDING_FAILURE`	Event detail type for failed onboarding.
`OFFBOARDING_REQUEST`	Event detail type for offboarding request.
`OFFBOARDING_SUCCESS`	Event detail type for successful offboarding.
`OFFBOARDING_FAILURE`	Event detail type for failed offboarding.
`PROVISION_SUCCESS`	Event detail type for successful provisioning.
`PROVISION_FAILURE`	Event detail type for failed provisioning.
`DEPROVISION_SUCCESS`	Event detail type for successful deprovisioning.
`DEPROVISION_FAILURE`	Event detail type for failed deprovisioning.
`BILLING_SUCCESS`	Event detail type for successful billing configuration.
`BILLING_FAILURE`	Event detail type for failure to configure billing.
`ACTIVATE_REQUEST`	Event detail type for activation request.
`ACTIVATE_SUCCESS`	Event detail type for successful activation.
`ACTIVATE_FAILURE`	Event detail type for failed activation.
`DEACTIVATE_REQUEST`	Event detail type for deactivation request.
`DEACTIVATE_SUCCESS`	Event detail type for successful deactivation.
`DEACTIVATE_FAILURE`	Event detail type for failed deactivation.
`TENANT_USER_CREATED`	Event detail type for user creation on the app-plane side.
`TENANT_USER_DELETED`	Event detail type for user deletion on the app-plane side.

`ONBOARDING_REQUEST`

Event detail type for onboarding request.

`ONBOARDING_SUCCESS`

Event detail type for successful onboarding.

`ONBOARDING_FAILURE`

Event detail type for failed onboarding.

`OFFBOARDING_REQUEST`

Event detail type for offboarding request.

`OFFBOARDING_SUCCESS`

Event detail type for successful offboarding.

`OFFBOARDING_FAILURE`

Event detail type for failed offboarding.

`PROVISION_SUCCESS`

Event detail type for successful provisioning.

`PROVISION_FAILURE`

Event detail type for failed provisioning.

`DEPROVISION_SUCCESS`

Event detail type for successful deprovisioning.

`DEPROVISION_FAILURE`

Event detail type for failed deprovisioning.

`BILLING_SUCCESS`

Event detail type for successful billing configuration.

`BILLING_FAILURE`

Event detail type for failure to configure billing.

`ACTIVATE_REQUEST`

Event detail type for activation request.

`ACTIVATE_SUCCESS`

Event detail type for successful activation.

`ACTIVATE_FAILURE`

Event detail type for failed activation.

`DEACTIVATE_REQUEST`

Event detail type for deactivation request.

`DEACTIVATE_SUCCESS`

Event detail type for successful deactivation.

`DEACTIVATE_FAILURE`

Event detail type for failed deactivation.

`TENANT_USER_CREATED`

Event detail type for user creation on the app-plane side.

Note that sbt-aws components do not emit this event. This event should be emitted by the application plane.

`TENANT_USER_DELETED`

Event detail type for user deletion on the app-plane side.

Note that sbt-aws components do not emit this event. This event should be emitted by the application plane.

Files

API.md

Latest commit

History

API.md

File metadata and controls

API Reference

Constructs

BashJobOrchestrator

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

Static Functions

isConstruct

xRequired

Properties

nodeRequired

eventTargetRequired

provisioningStateMachineRequired

BashJobRunner

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

Static Functions

isConstruct

xRequired

Properties

nodeRequired

codebuildProjectRequired

eventTargetRequired

environmentVariablesToOutgoingEventOptional

BillingProvider

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

Static Functions

isConstruct

xRequired

Properties

nodeRequired

controlPlaneAPIBillingWebhookResourceOptional

CognitoAuth

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

Static Functions

isConstruct

xRequired

Properties

nodeRequired

authorizationServerRequired

authorizerRequired

clientIdRequired

controlPlaneIdpDetailsRequired

createUserFunctionRequired

deleteUserFunctionRequired

disableUserFunctionRequired

enableUserFunctionRequired

fetchAllUsersFunctionRequired

fetchUserFunctionRequired

updateUserFunctionRequired

wellKnownEndpointUrlRequired

ControlPlane

Initializers

scopeRequired

idRequired

propsRequired

Methods

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`eventTarget`^Required

`provisioningStateMachine`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`codebuildProject`^Required

`eventTarget`^Required

`environmentVariablesToOutgoingEvent`^Optional

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`controlPlaneAPIBillingWebhookResource`^Optional

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`authorizationServer`^Required

`authorizer`^Required

`clientId`^Required

`controlPlaneIdpDetails`^Required

`createUserFunction`^Required

`deleteUserFunction`^Required

`disableUserFunction`^Required

`enableUserFunction`^Required

`fetchAllUsersFunction`^Required

`fetchUserFunction`^Required

`updateUserFunction`^Required

`wellKnownEndpointUrl`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`controlPlaneAPIGatewayUrl`^Required

`eventManager`^Required

`tables`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`billingResource`^Required

`tenantUpdateServiceTarget`^Required

`apiUrl`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`eventManager`^Required

`scope`^Required

`id`^Required

`props`^Optional

`toString`

`addTargetToEvent`

`eventType`^Required