# API Reference ## Constructs ### MicroApps - *Implements:* IMicroApps Create a new MicroApps "turnkey" construct for simple deployments and for initial evaulation of the MicroApps framework. Use this construct to create a PoC working entire stack. Do not use this construct when adding MicroApps to an existing CloudFront, API Gateway, S3 Bucket, etc. or where access to all features of the AWS Resources are needed (e.g. to add additional Behaviors to the CloudFront distribution, set authorizors on API Gateway, etc.). > [{@link https://github.com/pwrdrvr/microapps-core/blob/main/packages/cdk/lib/MicroApps.ts example usage in a CDK Stack }]({@link https://github.com/pwrdrvr/microapps-core/blob/main/packages/cdk/lib/MicroApps.ts example usage in a CDK Stack }) #### Initializers ```typescript import { MicroApps } from '@pwrdrvr/microapps-cdk' new MicroApps(scope: Construct, id: string, props?: MicroAppsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MicroAppsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* MicroAppsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { MicroApps } from '@pwrdrvr/microapps-cdk' MicroApps.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cf | IMicroAppsCF | {@inheritdoc IMicroAppsCF}. | | s3 | IMicroAppsS3 | {@inheritdoc IMicroAppsS3}. | | svcs | IMicroAppsSvcs | {@inheritdoc IMicroAppsSvcs}. | | edgeToOrigin | IMicroAppsEdgeToOrigin | {@inheritdoc IMicroAppsEdgeToOrigin}. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cf`^Required ```typescript public readonly cf: IMicroAppsCF; ``` - *Type:* IMicroAppsCF {@inheritdoc IMicroAppsCF}. --- ##### `s3`^Required ```typescript public readonly s3: IMicroAppsS3; ``` - *Type:* IMicroAppsS3 {@inheritdoc IMicroAppsS3}. --- ##### `svcs`^Required ```typescript public readonly svcs: IMicroAppsSvcs; ``` - *Type:* IMicroAppsSvcs {@inheritdoc IMicroAppsSvcs}. --- ##### `edgeToOrigin`^Optional ```typescript public readonly edgeToOrigin: IMicroAppsEdgeToOrigin; ``` - *Type:* IMicroAppsEdgeToOrigin {@inheritdoc IMicroAppsEdgeToOrigin}. --- ### MicroAppsCF - *Implements:* IMicroAppsCF Create a new MicroApps CloudFront Distribution. #### Initializers ```typescript import { MicroAppsCF } from '@pwrdrvr/microapps-cdk' new MicroAppsCF(scope: Construct, id: string, props: MicroAppsCFProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MicroAppsCFProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* MicroAppsCFProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | addRoutes | Add API Gateway and S3 routes to an existing CloudFront Distribution. | | createAPIOriginPolicy | Create or get the origin request policy. | --- ##### `isConstruct` ```typescript import { MicroAppsCF } from '@pwrdrvr/microapps-cdk' MicroAppsCF.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `addRoutes` ```typescript import { MicroAppsCF } from '@pwrdrvr/microapps-cdk' MicroAppsCF.addRoutes(_scope: Construct, props: AddRoutesOptions) ``` Add API Gateway and S3 routes to an existing CloudFront Distribution. ###### `_scope`^Required - *Type:* constructs.Construct --- ###### `props`^Required - *Type:* AddRoutesOptions --- ##### `createAPIOriginPolicy` ```typescript import { MicroAppsCF } from '@pwrdrvr/microapps-cdk' MicroAppsCF.createAPIOriginPolicy(_scope: Construct, _props: CreateAPIOriginPolicyOptions) ``` Create or get the origin request policy. If a custom domain name is NOT used for the origin then a policy will be created. If a custom domain name IS used for the origin then the ALL_VIEWER policy will be returned. This policy passes the Host header to the origin, which is fine when using a custom domain name on the origin. ###### `_scope`^Required - *Type:* constructs.Construct --- ###### `_props`^Required - *Type:* CreateAPIOriginPolicyOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cloudFrontDistro | aws-cdk-lib.aws_cloudfront.Distribution | The CloudFront distribution. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cloudFrontDistro`^Required ```typescript public readonly cloudFrontDistro: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution The CloudFront distribution. --- ### MicroAppsChildDeployer - *Implements:* IMicroAppsChildDeployer Create a new MicroApps Child Deployer construct. #### Initializers ```typescript import { MicroAppsChildDeployer } from '@pwrdrvr/microapps-cdk' new MicroAppsChildDeployer(scope: Construct, id: string, props?: MicroAppsChildDeployerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MicroAppsChildDeployerProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* MicroAppsChildDeployerProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { MicroAppsChildDeployer } from '@pwrdrvr/microapps-cdk' MicroAppsChildDeployer.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | deployerFunc | aws-cdk-lib.aws_lambda.IFunction | Lambda function for the Deployer. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `deployerFunc`^Required ```typescript public readonly deployerFunc: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction Lambda function for the Deployer. --- ### MicroAppsEdgeToOrigin - *Implements:* IMicroAppsEdgeToOrigin Create a new MicroApps Edge to Origin Function w/ `config.yml`. #### Initializers ```typescript import { MicroAppsEdgeToOrigin } from '@pwrdrvr/microapps-cdk' new MicroAppsEdgeToOrigin(scope: Construct, id: string, props: MicroAppsEdgeToOriginProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MicroAppsEdgeToOriginProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* MicroAppsEdgeToOriginProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | generateEdgeToOriginConfig | Generate the yaml config for the edge lambda. | --- ##### `isConstruct` ```typescript import { MicroAppsEdgeToOrigin } from '@pwrdrvr/microapps-cdk' MicroAppsEdgeToOrigin.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `generateEdgeToOriginConfig` ```typescript import { MicroAppsEdgeToOrigin } from '@pwrdrvr/microapps-cdk' MicroAppsEdgeToOrigin.generateEdgeToOriginConfig(props: GenerateEdgeToOriginConfigOptions) ``` Generate the yaml config for the edge lambda. ###### `props`^Required - *Type:* GenerateEdgeToOriginConfigOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | edgeToOriginFunction | aws-cdk-lib.aws_lambda.Function \| aws-cdk-lib.aws_cloudfront.experimental.EdgeFunction | The edge to origin function for API Gateway Request Origin Edge Lambda. | | edgeToOriginLambdas | aws-cdk-lib.aws_cloudfront.EdgeLambda[] | Configuration of the edge to origin lambda functions. | | edgeToOriginRole | aws-cdk-lib.aws_iam.Role | The IAM Role for the edge to origin function. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `edgeToOriginFunction`^Required ```typescript public readonly edgeToOriginFunction: Function | EdgeFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.Function | aws-cdk-lib.aws_cloudfront.experimental.EdgeFunction The edge to origin function for API Gateway Request Origin Edge Lambda. The generated `config.yml` is included in the Lambda's code. --- ##### `edgeToOriginLambdas`^Required ```typescript public readonly edgeToOriginLambdas: EdgeLambda[]; ``` - *Type:* aws-cdk-lib.aws_cloudfront.EdgeLambda[] Configuration of the edge to origin lambda functions. --- ##### `edgeToOriginRole`^Required ```typescript public readonly edgeToOriginRole: Role; ``` - *Type:* aws-cdk-lib.aws_iam.Role The IAM Role for the edge to origin function. --- ### MicroAppsS3 - *Implements:* IMicroAppsS3 Create the durable MicroApps S3 Buckets. These should be created in a stack that will not be deleted if there are breaking changes to MicroApps in the future. #### Initializers ```typescript import { MicroAppsS3 } from '@pwrdrvr/microapps-cdk' new MicroAppsS3(scope: Construct, id: string, props?: MicroAppsS3Props) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MicroAppsS3Props | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* MicroAppsS3Props --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { MicroAppsS3 } from '@pwrdrvr/microapps-cdk' MicroAppsS3.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | bucketApps | aws-cdk-lib.aws_s3.IBucket | S3 bucket for deployed applications. | | bucketAppsOAI | aws-cdk-lib.aws_cloudfront.OriginAccessIdentity | CloudFront Origin Access Identity for the deployed applications bucket. | | bucketAppsOriginApp | aws-cdk-lib.aws_cloudfront_origins.S3Origin | CloudFront Origin for the deployed applications bucket Marked with `x-microapps-origin: app` so the OriginRequest function knows to send the request to the application origin first, if configured for a particular application. | | bucketAppsOriginS3 | aws-cdk-lib.aws_cloudfront_origins.S3Origin | CloudFront Origin for the deployed applications bucket Marked with `x-microapps-origin: s3` so the OriginRequest function knows to NOT send the request to the application origin and instead let it fall through to the S3 bucket. | | bucketAppsStaging | aws-cdk-lib.aws_s3.IBucket | S3 bucket for staged applications (prior to deploy). | | bucketLogs | aws-cdk-lib.aws_s3.IBucket | S3 bucket for CloudFront logs. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `bucketApps`^Required ```typescript public readonly bucketApps: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for deployed applications. --- ##### `bucketAppsOAI`^Required ```typescript public readonly bucketAppsOAI: OriginAccessIdentity; ``` - *Type:* aws-cdk-lib.aws_cloudfront.OriginAccessIdentity CloudFront Origin Access Identity for the deployed applications bucket. --- ##### `bucketAppsOriginApp`^Required ```typescript public readonly bucketAppsOriginApp: S3Origin; ``` - *Type:* aws-cdk-lib.aws_cloudfront_origins.S3Origin CloudFront Origin for the deployed applications bucket Marked with `x-microapps-origin: app` so the OriginRequest function knows to send the request to the application origin first, if configured for a particular application. --- ##### `bucketAppsOriginS3`^Required ```typescript public readonly bucketAppsOriginS3: S3Origin; ``` - *Type:* aws-cdk-lib.aws_cloudfront_origins.S3Origin CloudFront Origin for the deployed applications bucket Marked with `x-microapps-origin: s3` so the OriginRequest function knows to NOT send the request to the application origin and instead let it fall through to the S3 bucket. --- ##### `bucketAppsStaging`^Required ```typescript public readonly bucketAppsStaging: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for staged applications (prior to deploy). --- ##### `bucketLogs`^Required ```typescript public readonly bucketLogs: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for CloudFront logs. --- ### MicroAppsSvcs - *Implements:* IMicroAppsSvcs Create a new MicroApps Services construct, including the Deployer and Router Lambda Functions, and the DynamoDB Table used by both. #### Initializers ```typescript import { MicroAppsSvcs } from '@pwrdrvr/microapps-cdk' new MicroAppsSvcs(scope: Construct, id: string, props?: MicroAppsSvcsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MicroAppsSvcsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* MicroAppsSvcsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { MicroAppsSvcs } from '@pwrdrvr/microapps-cdk' MicroAppsSvcs.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | deployerFunc | aws-cdk-lib.aws_lambda.Function | Lambda function for the Deployer. | | table | aws-cdk-lib.aws_dynamodb.ITable | DynamoDB table used by Router, Deployer, and Release console app. | | routerFunc | aws-cdk-lib.aws_lambda.Function | Lambda function for the Router. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `deployerFunc`^Required ```typescript public readonly deployerFunc: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function Lambda function for the Deployer. --- ##### `table`^Required ```typescript public readonly table: ITable; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITable DynamoDB table used by Router, Deployer, and Release console app. --- ##### `routerFunc`^Optional ```typescript public readonly routerFunc: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function Lambda function for the Router. --- ### MicroAppsTable - *Implements:* IMicroAppsTable Create a new MicroApps Table for apps / versions / rules. #### Initializers ```typescript import { MicroAppsTable } from '@pwrdrvr/microapps-cdk' new MicroAppsTable(scope: Construct, id: string, props?: MicroAppsTableProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MicroAppsTableProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* MicroAppsTableProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { MicroAppsTable } from '@pwrdrvr/microapps-cdk' MicroAppsTable.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | table | aws-cdk-lib.aws_dynamodb.Table | DynamoDB table used by Router, Deployer, and Release console app. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `table`^Required ```typescript public readonly table: Table; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Table DynamoDB table used by Router, Deployer, and Release console app. --- ## Structs ### AddRoutesOptions Options for `AddRoutes`. #### Initializer ```typescript import { AddRoutesOptions } from '@pwrdrvr/microapps-cdk' const addRoutesOptions: AddRoutesOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | appOnlyOrigin | aws-cdk-lib.aws_cloudfront.IOrigin | Application origin. | | appOriginRequestPolicy | aws-cdk-lib.aws_cloudfront.IOriginRequestPolicy | Origin Request policy for API Gateway Origin. | | bucketOriginFallbackToApp | aws-cdk-lib.aws_cloudfront_origins.OriginGroup | Origin Group with Primary of S3 bucket with `x-microapps-origin: s3` custom header and Fallback of `appOnlyOrigin`. | | distro | aws-cdk-lib.aws_cloudfront.Distribution | CloudFront Distribution to add the Behaviors (Routes) to. | | edgeLambdas | aws-cdk-lib.aws_cloudfront.EdgeLambda[] | Edge lambdas to associate with the API Gateway routes. | | rootPathPrefix | string | Path prefix on the root of the CloudFront distribution. | --- ##### `appOnlyOrigin`^Required ```typescript public readonly appOnlyOrigin: IOrigin; ``` - *Type:* aws-cdk-lib.aws_cloudfront.IOrigin Application origin. Typically an S3 bucket with a `x-microapps-origin: app` custom header The request never actually falls through to the S3 bucket. --- ##### `appOriginRequestPolicy`^Required ```typescript public readonly appOriginRequestPolicy: IOriginRequestPolicy; ``` - *Type:* aws-cdk-lib.aws_cloudfront.IOriginRequestPolicy Origin Request policy for API Gateway Origin. --- ##### `bucketOriginFallbackToApp`^Required ```typescript public readonly bucketOriginFallbackToApp: OriginGroup; ``` - *Type:* aws-cdk-lib.aws_cloudfront_origins.OriginGroup Origin Group with Primary of S3 bucket with `x-microapps-origin: s3` custom header and Fallback of `appOnlyOrigin`. --- ##### `distro`^Required ```typescript public readonly distro: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution CloudFront Distribution to add the Behaviors (Routes) to. --- ##### `edgeLambdas`^Optional ```typescript public readonly edgeLambdas: EdgeLambda[]; ``` - *Type:* aws-cdk-lib.aws_cloudfront.EdgeLambda[] Edge lambdas to associate with the API Gateway routes. --- ##### `rootPathPrefix`^Optional ```typescript public readonly rootPathPrefix: string; ``` - *Type:* string Path prefix on the root of the CloudFront distribution. --- *Example* ```typescript dev/ ``` ### CreateAPIOriginPolicyOptions Options for the `CreateAPIOriginPolicy`. #### Initializer ```typescript import { CreateAPIOriginPolicyOptions } from '@pwrdrvr/microapps-cdk' const createAPIOriginPolicyOptions: CreateAPIOriginPolicyOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetNameRoot | string | Optional asset name root. | | assetNameSuffix | string | Optional asset name suffix. | | domainNameEdge | string | Edge domain name used by CloudFront - If set a custom OriginRequestPolicy will be created that prevents the Host header from being passed to the origin. | --- ##### `assetNameRoot`^Optional ```typescript public readonly assetNameRoot: string; ``` - *Type:* string - *Default:* resource names auto assigned Optional asset name root. --- *Example* ```typescript microapps ``` ##### `assetNameSuffix`^Optional ```typescript public readonly assetNameSuffix: string; ``` - *Type:* string - *Default:* none Optional asset name suffix. --- *Example* ```typescript -dev-pr-12 ``` ##### `domainNameEdge`^Optional ```typescript public readonly domainNameEdge: string; ``` - *Type:* string Edge domain name used by CloudFront - If set a custom OriginRequestPolicy will be created that prevents the Host header from being passed to the origin. --- ### GenerateEdgeToOriginConfigOptions #### Initializer ```typescript import { GenerateEdgeToOriginConfigOptions } from '@pwrdrvr/microapps-cdk' const generateEdgeToOriginConfigOptions: GenerateEdgeToOriginConfigOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | addXForwardedHostHeader | boolean | *No description.* | | originRegion | string | *No description.* | | replaceHostHeader | boolean | *No description.* | | signingMode | string | *No description.* | | locales | string[] | *No description.* | | rootPathPrefix | string | *No description.* | | tableName | string | *No description.* | --- ##### `addXForwardedHostHeader`^Required ```typescript public readonly addXForwardedHostHeader: boolean; ``` - *Type:* boolean --- ##### `originRegion`^Required ```typescript public readonly originRegion: string; ``` - *Type:* string --- ##### `replaceHostHeader`^Required ```typescript public readonly replaceHostHeader: boolean; ``` - *Type:* boolean --- ##### `signingMode`^Required ```typescript public readonly signingMode: string; ``` - *Type:* string --- ##### `locales`^Optional ```typescript public readonly locales: string[]; ``` - *Type:* string[] --- ##### `rootPathPrefix`^Optional ```typescript public readonly rootPathPrefix: string; ``` - *Type:* string --- ##### `tableName`^Optional ```typescript public readonly tableName: string; ``` - *Type:* string --- ### MicroAppsCFProps Properties to initialize an instance of `MicroAppsCF`. #### Initializer ```typescript import { MicroAppsCFProps } from '@pwrdrvr/microapps-cdk' const microAppsCFProps: MicroAppsCFProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucketAppsOriginApp | aws-cdk-lib.aws_cloudfront_origins.S3Origin | S3 bucket origin for deployed applications Marked with `x-microapps-origin: app`. | | bucketAppsOriginS3 | aws-cdk-lib.aws_cloudfront_origins.S3Origin | S3 bucket origin for deployed applications Marked with `x-microapps-origin: s3`. | | assetNameRoot | string | Optional asset name root. | | assetNameSuffix | string | Optional asset name suffix. | | bucketLogs | aws-cdk-lib.aws_s3.IBucket | S3 bucket for CloudFront logs. | | certEdge | aws-cdk-lib.aws_certificatemanager.ICertificate | ACM Certificate that covers `domainNameEdge` name. | | createAPIPathRoute | boolean | Create an extra Behavior (Route) for /api/ that allows API routes to have a period in them. | | createNextDataPathRoute | boolean | Create an extra Behavior (Route) for /_next/data/ This route is used by Next.js to load data from the API Gateway on `getServerSideProps` calls. The requests can end in `.json`, which would cause them to be routed to S3 if this route is not created. | | domainNameEdge | string | CloudFront Distribution domain name. | | domainNameOrigin | string | API Gateway custom origin domain name. | | edgeLambdas | aws-cdk-lib.aws_cloudfront.EdgeLambda[] | Configuration of the edge to origin lambda functions. | | originShieldRegion | string | Optional Origin Shield Region. | | r53Zone | aws-cdk-lib.aws_route53.IHostedZone | Route53 zone in which to create optional `domainNameEdge` record. | | removalPolicy | aws-cdk-lib.RemovalPolicy | RemovalPolicy override for child resources. | | rootPathPrefix | string | Path prefix on the root of the CloudFront distribution. | --- ##### `bucketAppsOriginApp`^Required ```typescript public readonly bucketAppsOriginApp: S3Origin; ``` - *Type:* aws-cdk-lib.aws_cloudfront_origins.S3Origin S3 bucket origin for deployed applications Marked with `x-microapps-origin: app`. --- ##### `bucketAppsOriginS3`^Required ```typescript public readonly bucketAppsOriginS3: S3Origin; ``` - *Type:* aws-cdk-lib.aws_cloudfront_origins.S3Origin S3 bucket origin for deployed applications Marked with `x-microapps-origin: s3`. --- ##### `assetNameRoot`^Optional ```typescript public readonly assetNameRoot: string; ``` - *Type:* string - *Default:* resource names auto assigned Optional asset name root. --- *Example* ```typescript microapps ``` ##### `assetNameSuffix`^Optional ```typescript public readonly assetNameSuffix: string; ``` - *Type:* string - *Default:* none Optional asset name suffix. --- *Example* ```typescript -dev-pr-12 ``` ##### `bucketLogs`^Optional ```typescript public readonly bucketLogs: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for CloudFront logs. --- ##### `certEdge`^Optional ```typescript public readonly certEdge: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate ACM Certificate that covers `domainNameEdge` name. --- ##### `createAPIPathRoute`^Optional ```typescript public readonly createAPIPathRoute: boolean; ``` - *Type:* boolean - *Default:* true if httpApi is provided Create an extra Behavior (Route) for /api/ that allows API routes to have a period in them. When false API routes with a period in the path will get routed to S3. When true API routes that contain /api/ in the path will get routed to API Gateway even if they have a period in the path. --- ##### `createNextDataPathRoute`^Optional ```typescript public readonly createNextDataPathRoute: boolean; ``` - *Type:* boolean - *Default:* true if httpApi is provided Create an extra Behavior (Route) for /_next/data/ This route is used by Next.js to load data from the API Gateway on `getServerSideProps` calls. The requests can end in `.json`, which would cause them to be routed to S3 if this route is not created. When false API routes with a period in the path will get routed to S3. When true API routes that contain /_next/data/ in the path will get routed to API Gateway even if they have a period in the path. --- ##### `domainNameEdge`^Optional ```typescript public readonly domainNameEdge: string; ``` - *Type:* string - *Default:* auto-assigned CloudFront Distribution domain name. --- *Example* ```typescript apps.pwrdrvr.com ``` ##### `domainNameOrigin`^Optional ```typescript public readonly domainNameOrigin: string; ``` - *Type:* string - *Default:* retrieved from httpApi, if possible API Gateway custom origin domain name. --- *Example* ```typescript apps.pwrdrvr.com ``` ##### `edgeLambdas`^Optional ```typescript public readonly edgeLambdas: EdgeLambda[]; ``` - *Type:* aws-cdk-lib.aws_cloudfront.EdgeLambda[] - *Default:* no edge to API Gateway origin functions added Configuration of the edge to origin lambda functions. --- ##### `originShieldRegion`^Optional ```typescript public readonly originShieldRegion: string; ``` - *Type:* string - *Default:* none Optional Origin Shield Region. This should be the region where the DynamoDB is located so the EdgeToOrigin calls have the lowest latency (~1 ms). --- ##### `r53Zone`^Optional ```typescript public readonly r53Zone: IHostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.IHostedZone Route53 zone in which to create optional `domainNameEdge` record. --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* per resource default RemovalPolicy override for child resources. Note: if set to DESTROY the S3 buckes will have `autoDeleteObjects` set to `true` --- ##### `rootPathPrefix`^Optional ```typescript public readonly rootPathPrefix: string; ``` - *Type:* string Path prefix on the root of the CloudFront distribution. --- *Example* ```typescript dev/ ``` ### MicroAppsChildDeployerProps Properties to initialize an instance of `MicroAppsChildDeployer`. #### Initializer ```typescript import { MicroAppsChildDeployerProps } from '@pwrdrvr/microapps-cdk' const microAppsChildDeployerProps: MicroAppsChildDeployerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | appEnv | string | Application environment, passed as `NODE_ENV` to the Router and Deployer Lambda functions. | | parentDeployerLambdaARN | string | ARN of the parent Deployer Lambda Function. | | assetNameRoot | string | Optional asset name root. | | assetNameSuffix | string | Optional asset name suffix. | | deployerTimeout | aws-cdk-lib.Duration | Deployer timeout. | | edgeToOriginRoleARN | string | ARN of the IAM Role for the Edge to Origin Lambda Function. | | removalPolicy | aws-cdk-lib.RemovalPolicy | RemovalPolicy override for child resources. | --- ##### `appEnv`^Required ```typescript public readonly appEnv: string; ``` - *Type:* string Application environment, passed as `NODE_ENV` to the Router and Deployer Lambda functions. --- ##### `parentDeployerLambdaARN`^Required ```typescript public readonly parentDeployerLambdaARN: string; ``` - *Type:* string ARN of the parent Deployer Lambda Function. --- ##### `assetNameRoot`^Optional ```typescript public readonly assetNameRoot: string; ``` - *Type:* string - *Default:* resource names auto assigned Optional asset name root. --- *Example* ```typescript microapps ``` ##### `assetNameSuffix`^Optional ```typescript public readonly assetNameSuffix: string; ``` - *Type:* string - *Default:* none Optional asset name suffix. --- *Example* ```typescript -dev-pr-12 ``` ##### `deployerTimeout`^Optional ```typescript public readonly deployerTimeout: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* 2 minutes Deployer timeout. For larger applications this needs to be set up to 2-5 minutes for the S3 copy --- ##### `edgeToOriginRoleARN`^Optional ```typescript public readonly edgeToOriginRoleARN: string; ``` - *Type:* string ARN of the IAM Role for the Edge to Origin Lambda Function. For child accounts this can be blank as it is retrieved from the parent Deployer --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* per resource default RemovalPolicy override for child resources. Note: if set to DESTROY the S3 buckes will have `autoDeleteObjects` set to `true` --- ### MicroAppsEdgeToOriginProps Properties to initialize an instance of `MicroAppsEdgeToOrigin`. #### Initializer ```typescript import { MicroAppsEdgeToOriginProps } from '@pwrdrvr/microapps-cdk' const microAppsEdgeToOriginProps: MicroAppsEdgeToOriginProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | addXForwardedHostHeader | boolean | Adds an X-Forwarded-Host-Header when calling API Gateway. | | allowedFunctionUrlAccounts | string[] | Account IDs allowed for cross-account Function URL invocations. | | allowedLocalePrefixes | string[] | List of allowed locale prefixes for pages. | | assetNameRoot | string | Optional asset name root. | | assetNameSuffix | string | Optional asset name suffix. | | originRegion | string | Origin region that API Gateway will be deployed to, used for the config.yml on the Edge function to sign requests for the correct region. | | removalPolicy | aws-cdk-lib.RemovalPolicy | RemovalPolicy override for child resources. | | replaceHostHeader | boolean | Replaces Host header (which will be the Edge domain name) with the Origin domain name when enabled. | | rootPathPrefix | string | Path prefix on the root of the API Gateway Stage. | | setupApiGatewayPermissions | boolean | Enable invoking API Gateway from the Edge Lambda. | | signingMode | string | Requires IAM auth on the API Gateway origin if not set to 'none'. | | tableRulesArn | string | DynamoDB Table Name for apps/versions/rules. | --- ##### `addXForwardedHostHeader`^Optional ```typescript public readonly addXForwardedHostHeader: boolean; ``` - *Type:* boolean - *Default:* true Adds an X-Forwarded-Host-Header when calling API Gateway. Can only be trusted if `signingMode` is enabled, which restricts access to API Gateway to only IAM signed requests. Note: if true, creates OriginRequest Lambda @ Edge function for API Gateway Origin --- ##### `allowedFunctionUrlAccounts`^Optional ```typescript public readonly allowedFunctionUrlAccounts: string[]; ``` - *Type:* string[] - *Default:* [] Account IDs allowed for cross-account Function URL invocations. --- ##### `allowedLocalePrefixes`^Optional ```typescript public readonly allowedLocalePrefixes: string[]; ``` - *Type:* string[] - *Default:* none List of allowed locale prefixes for pages. --- *Example* ```typescript : ['en', 'fr', 'es'] ``` ##### `assetNameRoot`^Optional ```typescript public readonly assetNameRoot: string; ``` - *Type:* string - *Default:* resource names auto assigned Optional asset name root. --- *Example* ```typescript microapps ``` ##### `assetNameSuffix`^Optional ```typescript public readonly assetNameSuffix: string; ``` - *Type:* string - *Default:* none Optional asset name suffix. --- *Example* ```typescript -dev-pr-12 ``` ##### `originRegion`^Optional ```typescript public readonly originRegion: string; ``` - *Type:* string - *Default:* undefined Origin region that API Gateway will be deployed to, used for the config.yml on the Edge function to sign requests for the correct region. Note that Lambda FunctionURLs get the region from the Lambda ARN and do not need this to be configured. --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* per resource default RemovalPolicy override for child resources. --- ##### `replaceHostHeader`^Optional ```typescript public readonly replaceHostHeader: boolean; ``` - *Type:* boolean - *Default:* true Replaces Host header (which will be the Edge domain name) with the Origin domain name when enabled. This is necessary when API Gateway has not been configured with a custom domain name that matches the exact domain name used by the CloudFront Distribution AND when the OriginRequestPolicy.HeadersBehavior is set to pass all headers to the origin. Note: if true, creates OriginRequest Lambda @ Edge function for API Gateway Origin --- ##### `rootPathPrefix`^Optional ```typescript public readonly rootPathPrefix: string; ``` - *Type:* string - *Default:* none Path prefix on the root of the API Gateway Stage. --- *Example* ```typescript dev/ ``` ##### `setupApiGatewayPermissions`^Optional ```typescript public readonly setupApiGatewayPermissions: boolean; ``` - *Type:* boolean - *Default:* false Enable invoking API Gateway from the Edge Lambda. --- ##### `signingMode`^Optional ```typescript public readonly signingMode: string; ``` - *Type:* string - *Default:* 'sign' Requires IAM auth on the API Gateway origin if not set to 'none'. 'sign' - Uses request headers for auth. 'presign' - Uses query string for auth. If enabled, Note: if 'sign' or 'presign', creates OriginRequest Lambda @ Edge function for API Gateway Origin --- ##### `tableRulesArn`^Optional ```typescript public readonly tableRulesArn: string; ``` - *Type:* string DynamoDB Table Name for apps/versions/rules. Must be a full ARN as this can be cross region. Implies that 2nd generation routing is enabled. --- ### MicroAppsProps Properties to initialize an instance of `MicroApps`. #### Initializer ```typescript import { MicroAppsProps } from '@pwrdrvr/microapps-cdk' const microAppsProps: MicroAppsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | appEnv | string | Passed to NODE_ENV of Router and Deployer Lambda functions. | | addXForwardedHostHeader | boolean | Adds an X-Forwarded-Host-Header when calling API Gateway. | | allowedFunctionUrlAccounts | string[] | Account IDs allowed for cross-account Function URL invocations. | | allowedLocalePrefixes | string[] | List of allowed locale prefixes for pages. | | assetNameRoot | string | Optional asset name root. | | assetNameSuffix | string | Optional asset name suffix. | | certEdge | aws-cdk-lib.aws_certificatemanager.ICertificate | Certificate in US-East-1 for the CloudFront distribution. | | certOrigin | aws-cdk-lib.aws_certificatemanager.ICertificate | Certificate in deployed region for the API Gateway. | | createAPIGateway | boolean | Create API Gateway for non-edge invocation. | | createAPIPathRoute | boolean | Create an extra Behavior (Route) for /api/ that allows API routes to have a period in them. | | createNextDataPathRoute | boolean | Create an extra Behavior (Route) for /_next/data/ This route is used by Next.js to load data from the API Gateway on `getServerSideProps` calls. The requests can end in `.json`, which would cause them to be routed to S3 if this route is not created. | | domainNameEdge | string | Optional custom domain name for the CloudFront distribution. | | domainNameOrigin | string | Optional custom domain name for the API Gateway HTTPv2 API. | | edgeLambdas | aws-cdk-lib.aws_cloudfront.EdgeLambda[] | Additional edge lambda functions. | | edgeToOriginRoleARNs | string[] | Additional IAM Role ARNs that should be allowed to invoke apps in child accounts. | | originRegion | string | Origin region that API Gateway or Lambda function will be deployed to, used for the config.yml on the Edge function to sign requests for the correct region. | | originShieldRegion | string | Optional Origin Shield Region. | | r53Zone | aws-cdk-lib.aws_route53.IHostedZone | Route53 zone in which to create optional `domainNameEdge` record. | | removalPolicy | aws-cdk-lib.RemovalPolicy | RemovalPolicy override for child resources. | | replaceHostHeader | boolean | Replaces Host header (which will be the Edge domain name) with the Origin domain name when enabled. | | rootPathPrefix | string | Path prefix on the root of the CloudFront distribution. | | s3PolicyBypassAROAs | string[] | Applies when using s3StrictBucketPolicy = true. | | s3PolicyBypassPrincipalARNs | string[] | Applies when using s3StrictBucketPolicy = true. | | s3StrictBucketPolicy | boolean | Use a strict S3 Bucket Policy that prevents applications from reading/writing/modifying/deleting files in the S3 Bucket outside of the path that is specific to their app/version. | | signingMode | string | Requires IAM auth on the API Gateway origin if not set to 'none'. | | table | aws-cdk-lib.aws_dynamodb.ITable \| aws-cdk-lib.aws_dynamodb.ITableV2 | Existing table for apps/versions/rules. | | tableNameForEdgeToOrigin | string | Pre-set table name for apps/versions/rules. | --- ##### `appEnv`^Required ```typescript public readonly appEnv: string; ``` - *Type:* string - *Default:* dev Passed to NODE_ENV of Router and Deployer Lambda functions. --- ##### `addXForwardedHostHeader`^Optional ```typescript public readonly addXForwardedHostHeader: boolean; ``` - *Type:* boolean - *Default:* true Adds an X-Forwarded-Host-Header when calling API Gateway. Can only be trusted if `signingMode` is enabled, which restricts access to API Gateway to only IAM signed requests. Note: if true, creates OriginRequest Lambda @ Edge function for API Gateway Origin --- ##### `allowedFunctionUrlAccounts`^Optional ```typescript public readonly allowedFunctionUrlAccounts: string[]; ``` - *Type:* string[] - *Default:* [] Account IDs allowed for cross-account Function URL invocations. --- ##### `allowedLocalePrefixes`^Optional ```typescript public readonly allowedLocalePrefixes: string[]; ``` - *Type:* string[] - *Default:* none List of allowed locale prefixes for pages. --- *Example* ```typescript : ['en', 'fr', 'es'] ``` ##### `assetNameRoot`^Optional ```typescript public readonly assetNameRoot: string; ``` - *Type:* string - *Default:* resource names auto assigned Optional asset name root. --- *Example* ```typescript microapps ``` ##### `assetNameSuffix`^Optional ```typescript public readonly assetNameSuffix: string; ``` - *Type:* string - *Default:* none Optional asset name suffix. --- *Example* ```typescript -dev-pr-12 ``` ##### `certEdge`^Optional ```typescript public readonly certEdge: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate Certificate in US-East-1 for the CloudFront distribution. --- ##### `certOrigin`^Optional ```typescript public readonly certOrigin: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate Certificate in deployed region for the API Gateway. --- ##### `createAPIGateway`^Optional ```typescript public readonly createAPIGateway: boolean; ``` - *Type:* boolean - *Default:* false Create API Gateway for non-edge invocation. --- ##### `createAPIPathRoute`^Optional ```typescript public readonly createAPIPathRoute: boolean; ``` - *Type:* boolean - *Default:* true Create an extra Behavior (Route) for /api/ that allows API routes to have a period in them. When false API routes with a period in the path will get routed to S3. When true API routes that contain /api/ in the path will get routed to API Gateway even if they have a period in the path. --- ##### `createNextDataPathRoute`^Optional ```typescript public readonly createNextDataPathRoute: boolean; ``` - *Type:* boolean - *Default:* true Create an extra Behavior (Route) for /_next/data/ This route is used by Next.js to load data from the API Gateway on `getServerSideProps` calls. The requests can end in `.json`, which would cause them to be routed to S3 if this route is not created. When false API routes with a period in the path will get routed to S3. When true API routes that contain /_next/data/ in the path will get routed to API Gateway even if they have a period in the path. --- ##### `domainNameEdge`^Optional ```typescript public readonly domainNameEdge: string; ``` - *Type:* string - *Default:* auto-assigned Optional custom domain name for the CloudFront distribution. --- *Example* ```typescript apps.pwrdrvr.com ``` ##### `domainNameOrigin`^Optional ```typescript public readonly domainNameOrigin: string; ``` - *Type:* string - *Default:* auto-assigned Optional custom domain name for the API Gateway HTTPv2 API. --- *Example* ```typescript apps-origin.pwrdrvr.com ``` ##### `edgeLambdas`^Optional ```typescript public readonly edgeLambdas: EdgeLambda[]; ``` - *Type:* aws-cdk-lib.aws_cloudfront.EdgeLambda[] Additional edge lambda functions. --- ##### `edgeToOriginRoleARNs`^Optional ```typescript public readonly edgeToOriginRoleARNs: string[]; ``` - *Type:* string[] Additional IAM Role ARNs that should be allowed to invoke apps in child accounts. --- ##### `originRegion`^Optional ```typescript public readonly originRegion: string; ``` - *Type:* string - *Default:* undefined Origin region that API Gateway or Lambda function will be deployed to, used for the config.yml on the Edge function to sign requests for the correct region. --- ##### `originShieldRegion`^Optional ```typescript public readonly originShieldRegion: string; ``` - *Type:* string - *Default:* originRegion if specified, otherwise undefined Optional Origin Shield Region. This should be the region where the DynamoDB is located so the EdgeToOrigin calls have the lowest latency (~1 ms). --- ##### `r53Zone`^Optional ```typescript public readonly r53Zone: IHostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.IHostedZone Route53 zone in which to create optional `domainNameEdge` record. --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* per resource default RemovalPolicy override for child resources. Note: if set to DESTROY the S3 buckes will have `autoDeleteObjects` set to `true` --- ##### `replaceHostHeader`^Optional ```typescript public readonly replaceHostHeader: boolean; ``` - *Type:* boolean - *Default:* true Replaces Host header (which will be the Edge domain name) with the Origin domain name when enabled. This is necessary when API Gateway has not been configured with a custom domain name that matches the exact domain name used by the CloudFront Distribution AND when the OriginRequestPolicy.HeadersBehavior is set to pass all headers to the origin. Note: if true, creates OriginRequest Lambda @ Edge function for API Gateway Origin --- ##### `rootPathPrefix`^Optional ```typescript public readonly rootPathPrefix: string; ``` - *Type:* string Path prefix on the root of the CloudFront distribution. --- *Example* ```typescript dev/ ``` ##### `s3PolicyBypassAROAs`^Optional ```typescript public readonly s3PolicyBypassAROAs: string[]; ``` - *Type:* string[] Applies when using s3StrictBucketPolicy = true. AROAs of the IAM Role to exclude from the DENY rules on the S3 Bucket Policy. This allows sessions that assume the IAM Role to be excluded from the DENY rules on the S3 Bucket Policy. Typically any admin roles / users that need to view or manage the S3 Bucket would be added to this list. Roles / users that are used directly, not assumed, can be added to `s3PolicyBypassRoleNames` instead. Note: This AROA must be specified to prevent this policy from locking out non-root sessions that have assumed the admin role. The notPrincipals will only match the role name exactly and will not match any session that has assumed the role since notPrincipals does not allow wildcard matches and does not do wildcard matches implicitly either. The AROA must be used because there are only 3 Principal variables available: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html#principaltable aws:username, aws:userid, aws:PrincipalTag For an assumed role, aws:username is blank, aws:userid is: [unique id AKA AROA for Role]:[session name] Table of unique ID prefixes such as AROA: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-prefixes The name of the role is simply not available for an assumed role and, if it was, a complicated comparison would be requierd to prevent exclusion of applying the Deny Rule to roles from other accounts. To get the AROA with the AWS CLI: aws iam get-role --role-name ROLE-NAME aws iam get-user --user-name USER-NAME > [s3StrictBucketPolicy](s3StrictBucketPolicy) --- *Example* ```typescript [ 'AROA1234567890123' ] ``` ##### `s3PolicyBypassPrincipalARNs`^Optional ```typescript public readonly s3PolicyBypassPrincipalARNs: string[]; ``` - *Type:* string[] Applies when using s3StrictBucketPolicy = true. IAM Role or IAM User names to exclude from the DENY rules on the S3 Bucket Policy. Roles that are Assumed must instead have their AROA added to `s3PolicyBypassAROAs`. Typically any admin roles / users that need to view or manage the S3 Bucket would be added to this list. > [s3PolicyBypassAROAs](s3PolicyBypassAROAs) --- *Example* ```typescript ['arn:aws:iam::1234567890123:role/AdminAccess', 'arn:aws:iam::1234567890123:user/MyAdminUser'] ``` ##### `s3StrictBucketPolicy`^Optional ```typescript public readonly s3StrictBucketPolicy: boolean; ``` - *Type:* boolean - *Default:* false Use a strict S3 Bucket Policy that prevents applications from reading/writing/modifying/deleting files in the S3 Bucket outside of the path that is specific to their app/version. This setting should be used when applications are less than fully trusted. --- ##### `signingMode`^Optional ```typescript public readonly signingMode: string; ``` - *Type:* string - *Default:* 'sign' Requires IAM auth on the API Gateway origin if not set to 'none'. 'sign' - Uses request headers for auth. 'presign' - Uses query string for auth. If enabled, Note: if 'sign' or 'presign', creates OriginRequest Lambda @ Edge function for API Gateway Origin --- ##### `table`^Optional ```typescript public readonly table: ITable | ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITable | aws-cdk-lib.aws_dynamodb.ITableV2 - *Default:* created by construct Existing table for apps/versions/rules. --- ##### `tableNameForEdgeToOrigin`^Optional ```typescript public readonly tableNameForEdgeToOrigin: string; ``` - *Type:* string Pre-set table name for apps/versions/rules. This is required when using v2 routing --- ### MicroAppsS3Props Properties to initialize an instance of `MicroAppsS3`. #### Initializer ```typescript import { MicroAppsS3Props } from '@pwrdrvr/microapps-cdk' const microAppsS3Props: MicroAppsS3Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetNameRoot | string | Optional asset name root. | | assetNameSuffix | string | Optional asset name suffix. | | bucketAppsName | string | S3 deployed apps bucket name. | | bucketAppsStagingName | string | S3 staging apps bucket name. | | bucketLogsName | string | S3 logs bucket name. | | originShieldRegion | string | Optional Origin Shield Region. | | removalPolicy | aws-cdk-lib.RemovalPolicy | RemovalPolicy override for child resources. | --- ##### `assetNameRoot`^Optional ```typescript public readonly assetNameRoot: string; ``` - *Type:* string - *Default:* resource names auto assigned Optional asset name root. --- *Example* ```typescript microapps ``` ##### `assetNameSuffix`^Optional ```typescript public readonly assetNameSuffix: string; ``` - *Type:* string - *Default:* none Optional asset name suffix. --- *Example* ```typescript -dev-pr-12 ``` ##### `bucketAppsName`^Optional ```typescript public readonly bucketAppsName: string; ``` - *Type:* string - *Default:* auto-assigned S3 deployed apps bucket name. --- ##### `bucketAppsStagingName`^Optional ```typescript public readonly bucketAppsStagingName: string; ``` - *Type:* string - *Default:* auto-assigned S3 staging apps bucket name. --- ##### `bucketLogsName`^Optional ```typescript public readonly bucketLogsName: string; ``` - *Type:* string - *Default:* auto-assigned S3 logs bucket name. --- ##### `originShieldRegion`^Optional ```typescript public readonly originShieldRegion: string; ``` - *Type:* string - *Default:* none Optional Origin Shield Region. This should be the region where the DynamoDB is located so the EdgeToOrigin calls have the lowest latency (~1 ms). --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* per resource default RemovalPolicy override for child resources. Note: if set to DESTROY the S3 buckets will have `autoDeleteObjects` set to `true` --- ### MicroAppsSvcsProps Properties to initialize an instance of `MicroAppsSvcs`. #### Initializer ```typescript import { MicroAppsSvcsProps } from '@pwrdrvr/microapps-cdk' const microAppsSvcsProps: MicroAppsSvcsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | appEnv | string | Application environment, passed as `NODE_ENV` to the Router and Deployer Lambda functions. | | bucketApps | aws-cdk-lib.aws_s3.IBucket | S3 bucket for deployed applications. | | bucketAppsOAI | aws-cdk-lib.aws_cloudfront.OriginAccessIdentity | CloudFront Origin Access Identity for the deployed applications bucket. | | bucketAppsStaging | aws-cdk-lib.aws_s3.IBucket | S3 bucket for staged applications (prior to deploy). | | assetNameRoot | string | Optional asset name root. | | assetNameSuffix | string | Optional asset name suffix. | | deployerTimeout | aws-cdk-lib.Duration | Deployer timeout. | | edgeToOriginRoleARN | string[] | ARN of the IAM Role for the Edge to Origin Lambda Function. | | removalPolicy | aws-cdk-lib.RemovalPolicy | RemovalPolicy override for child resources. | | requireIAMAuthorization | boolean | Require IAM auth on API Gateway and Lambda Function URLs. | | rootPathPrefix | string | Path prefix on the root of the deployment. | | s3PolicyBypassAROAs | string[] | Applies when using s3StrictBucketPolicy = true. | | s3PolicyBypassPrincipalARNs | string[] | Applies when using s3StrictBucketPolicy = true. | | s3StrictBucketPolicy | boolean | Use a strict S3 Bucket Policy that prevents applications from reading/writing/modifying/deleting files in the S3 Bucket outside of the path that is specific to their app/version. | | table | aws-cdk-lib.aws_dynamodb.ITable | Existing table for apps/versions/rules. | --- ##### `appEnv`^Required ```typescript public readonly appEnv: string; ``` - *Type:* string Application environment, passed as `NODE_ENV` to the Router and Deployer Lambda functions. --- ##### `bucketApps`^Required ```typescript public readonly bucketApps: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for deployed applications. --- ##### `bucketAppsOAI`^Required ```typescript public readonly bucketAppsOAI: OriginAccessIdentity; ``` - *Type:* aws-cdk-lib.aws_cloudfront.OriginAccessIdentity CloudFront Origin Access Identity for the deployed applications bucket. --- ##### `bucketAppsStaging`^Required ```typescript public readonly bucketAppsStaging: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for staged applications (prior to deploy). --- ##### `assetNameRoot`^Optional ```typescript public readonly assetNameRoot: string; ``` - *Type:* string - *Default:* resource names auto assigned Optional asset name root. --- *Example* ```typescript microapps ``` ##### `assetNameSuffix`^Optional ```typescript public readonly assetNameSuffix: string; ``` - *Type:* string - *Default:* none Optional asset name suffix. --- *Example* ```typescript -dev-pr-12 ``` ##### `deployerTimeout`^Optional ```typescript public readonly deployerTimeout: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* 2 minutes Deployer timeout. For larger applications this needs to be set up to 2-5 minutes for the S3 copy --- ##### `edgeToOriginRoleARN`^Optional ```typescript public readonly edgeToOriginRoleARN: string[]; ``` - *Type:* string[] ARN of the IAM Role for the Edge to Origin Lambda Function. --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* per resource default RemovalPolicy override for child resources. Note: if set to DESTROY the S3 buckes will have `autoDeleteObjects` set to `true` --- ##### `requireIAMAuthorization`^Optional ```typescript public readonly requireIAMAuthorization: boolean; ``` - *Type:* boolean - *Default:* true Require IAM auth on API Gateway and Lambda Function URLs. --- ##### `rootPathPrefix`^Optional ```typescript public readonly rootPathPrefix: string; ``` - *Type:* string - *Default:* none Path prefix on the root of the deployment. --- *Example* ```typescript dev/ ``` ##### `s3PolicyBypassAROAs`^Optional ```typescript public readonly s3PolicyBypassAROAs: string[]; ``` - *Type:* string[] Applies when using s3StrictBucketPolicy = true. AROAs of the IAM Role to exclude from the DENY rules on the S3 Bucket Policy. This allows sessions that assume the IAM Role to be excluded from the DENY rules on the S3 Bucket Policy. Typically any admin roles / users that need to view or manage the S3 Bucket would be added to this list. Roles / users that are used directly, not assumed, can be added to `s3PolicyBypassRoleNames` instead. Note: This AROA must be specified to prevent this policy from locking out non-root sessions that have assumed the admin role. The notPrincipals will only match the role name exactly and will not match any session that has assumed the role since notPrincipals does not allow wildcard matches and does not do wildcard matches implicitly either. The AROA must be used because there are only 3 Principal variables available: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html#principaltable aws:username, aws:userid, aws:PrincipalTag For an assumed role, aws:username is blank, aws:userid is: [unique id AKA AROA for Role]:[session name] Table of unique ID prefixes such as AROA: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-prefixes The name of the role is simply not available for an assumed role and, if it was, a complicated comparison would be requierd to prevent exclusion of applying the Deny Rule to roles from other accounts. To get the AROA with the AWS CLI: aws iam get-role --role-name ROLE-NAME aws iam get-user --user-name USER-NAME > [s3StrictBucketPolicy](s3StrictBucketPolicy) --- *Example* ```typescript [ 'AROA1234567890123' ] ``` ##### `s3PolicyBypassPrincipalARNs`^Optional ```typescript public readonly s3PolicyBypassPrincipalARNs: string[]; ``` - *Type:* string[] Applies when using s3StrictBucketPolicy = true. IAM Role or IAM User names to exclude from the DENY rules on the S3 Bucket Policy. Roles that are Assumed must instead have their AROA added to `s3PolicyBypassAROAs`. Typically any admin roles / users that need to view or manage the S3 Bucket would be added to this list. > [s3PolicyBypassAROAs](s3PolicyBypassAROAs) --- *Example* ```typescript ['arn:aws:iam::1234567890123:role/AdminAccess', 'arn:aws:iam::1234567890123:user/MyAdminUser'] ``` ##### `s3StrictBucketPolicy`^Optional ```typescript public readonly s3StrictBucketPolicy: boolean; ``` - *Type:* boolean - *Default:* false Use a strict S3 Bucket Policy that prevents applications from reading/writing/modifying/deleting files in the S3 Bucket outside of the path that is specific to their app/version. This setting should be used when applications are less than fully trusted. --- ##### `table`^Optional ```typescript public readonly table: ITable; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITable - *Default:* created by construct Existing table for apps/versions/rules. --- ### MicroAppsTableProps Properties to initialize an instance of `MicroAppsTable`. #### Initializer ```typescript import { MicroAppsTableProps } from '@pwrdrvr/microapps-cdk' const microAppsTableProps: MicroAppsTableProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetNameRoot | string | Optional asset name root. | | assetNameSuffix | string | Optional asset name suffix. | | removalPolicy | aws-cdk-lib.RemovalPolicy | RemovalPolicy override for child resources. | --- ##### `assetNameRoot`^Optional ```typescript public readonly assetNameRoot: string; ``` - *Type:* string - *Default:* resource names auto assigned Optional asset name root. --- *Example* ```typescript microapps ``` ##### `assetNameSuffix`^Optional ```typescript public readonly assetNameSuffix: string; ``` - *Type:* string - *Default:* none Optional asset name suffix. --- *Example* ```typescript -dev-pr-12 ``` ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* per resource default RemovalPolicy override for child resources. Note: if set to DESTROY the S3 buckes will have `autoDeleteObjects` set to `true` --- ## Protocols ### IMicroApps - *Implemented By:* MicroApps, IMicroApps Represents a MicroApps. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cf | IMicroAppsCF | {@inheritdoc IMicroAppsCF}. | | s3 | IMicroAppsS3 | {@inheritdoc IMicroAppsS3}. | | svcs | IMicroAppsSvcs | {@inheritdoc IMicroAppsSvcs}. | | edgeToOrigin | IMicroAppsEdgeToOrigin | {@inheritdoc IMicroAppsEdgeToOrigin}. | --- ##### `cf`^Required ```typescript public readonly cf: IMicroAppsCF; ``` - *Type:* IMicroAppsCF {@inheritdoc IMicroAppsCF}. --- ##### `s3`^Required ```typescript public readonly s3: IMicroAppsS3; ``` - *Type:* IMicroAppsS3 {@inheritdoc IMicroAppsS3}. --- ##### `svcs`^Required ```typescript public readonly svcs: IMicroAppsSvcs; ``` - *Type:* IMicroAppsSvcs {@inheritdoc IMicroAppsSvcs}. --- ##### `edgeToOrigin`^Optional ```typescript public readonly edgeToOrigin: IMicroAppsEdgeToOrigin; ``` - *Type:* IMicroAppsEdgeToOrigin {@inheritdoc IMicroAppsEdgeToOrigin}. --- ### IMicroAppsCF - *Implemented By:* MicroAppsCF, IMicroAppsCF Represents a MicroApps CloudFront. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cloudFrontDistro | aws-cdk-lib.aws_cloudfront.Distribution | The CloudFront distribution. | --- ##### `cloudFrontDistro`^Required ```typescript public readonly cloudFrontDistro: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution The CloudFront distribution. --- ### IMicroAppsChildDeployer - *Implemented By:* MicroAppsChildDeployer, IMicroAppsChildDeployer Represents a MicroApps Child Deployer. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | deployerFunc | aws-cdk-lib.aws_lambda.IFunction | Lambda function for the Deployer. | --- ##### `deployerFunc`^Required ```typescript public readonly deployerFunc: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction Lambda function for the Deployer. --- ### IMicroAppsEdgeToOrigin - *Implemented By:* MicroAppsEdgeToOrigin, IMicroAppsEdgeToOrigin Represents a MicroApps Edge to Origin Function. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | edgeToOriginFunction | aws-cdk-lib.aws_lambda.Function \| aws-cdk-lib.aws_cloudfront.experimental.EdgeFunction | The edge to origin function for API Gateway Request Origin Edge Lambda. | | edgeToOriginLambdas | aws-cdk-lib.aws_cloudfront.EdgeLambda[] | Configuration of the edge to origin lambda functions. | | edgeToOriginRole | aws-cdk-lib.aws_iam.Role | The IAM Role for the edge to origin function. | --- ##### `edgeToOriginFunction`^Required ```typescript public readonly edgeToOriginFunction: Function | EdgeFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.Function | aws-cdk-lib.aws_cloudfront.experimental.EdgeFunction The edge to origin function for API Gateway Request Origin Edge Lambda. The generated `config.yml` is included in the Lambda's code. --- ##### `edgeToOriginLambdas`^Required ```typescript public readonly edgeToOriginLambdas: EdgeLambda[]; ``` - *Type:* aws-cdk-lib.aws_cloudfront.EdgeLambda[] Configuration of the edge to origin lambda functions. --- ##### `edgeToOriginRole`^Required ```typescript public readonly edgeToOriginRole: Role; ``` - *Type:* aws-cdk-lib.aws_iam.Role The IAM Role for the edge to origin function. --- ### IMicroAppsS3 - *Implemented By:* MicroAppsS3, IMicroAppsS3 Represents a MicroApps S3. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucketApps | aws-cdk-lib.aws_s3.IBucket | S3 bucket for deployed applications. | | bucketAppsOAI | aws-cdk-lib.aws_cloudfront.OriginAccessIdentity | CloudFront Origin Access Identity for the deployed applications bucket. | | bucketAppsOriginApp | aws-cdk-lib.aws_cloudfront_origins.S3Origin | CloudFront Origin for the deployed applications bucket Marked with `x-microapps-origin: app` so the OriginRequest function knows to send the request to the application origin first, if configured for a particular application. | | bucketAppsOriginS3 | aws-cdk-lib.aws_cloudfront_origins.S3Origin | CloudFront Origin for the deployed applications bucket Marked with `x-microapps-origin: s3` so the OriginRequest function knows to NOT send the request to the application origin and instead let it fall through to the S3 bucket. | | bucketAppsStaging | aws-cdk-lib.aws_s3.IBucket | S3 bucket for staged applications (prior to deploy). | | bucketLogs | aws-cdk-lib.aws_s3.IBucket | S3 bucket for CloudFront logs. | --- ##### `bucketApps`^Required ```typescript public readonly bucketApps: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for deployed applications. --- ##### `bucketAppsOAI`^Required ```typescript public readonly bucketAppsOAI: OriginAccessIdentity; ``` - *Type:* aws-cdk-lib.aws_cloudfront.OriginAccessIdentity CloudFront Origin Access Identity for the deployed applications bucket. --- ##### `bucketAppsOriginApp`^Required ```typescript public readonly bucketAppsOriginApp: S3Origin; ``` - *Type:* aws-cdk-lib.aws_cloudfront_origins.S3Origin CloudFront Origin for the deployed applications bucket Marked with `x-microapps-origin: app` so the OriginRequest function knows to send the request to the application origin first, if configured for a particular application. --- ##### `bucketAppsOriginS3`^Required ```typescript public readonly bucketAppsOriginS3: S3Origin; ``` - *Type:* aws-cdk-lib.aws_cloudfront_origins.S3Origin CloudFront Origin for the deployed applications bucket Marked with `x-microapps-origin: s3` so the OriginRequest function knows to NOT send the request to the application origin and instead let it fall through to the S3 bucket. --- ##### `bucketAppsStaging`^Required ```typescript public readonly bucketAppsStaging: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for staged applications (prior to deploy). --- ##### `bucketLogs`^Required ```typescript public readonly bucketLogs: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for CloudFront logs. --- ### IMicroAppsSvcs - *Implemented By:* MicroAppsSvcs, IMicroAppsSvcs Represents a MicroApps Services. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | deployerFunc | aws-cdk-lib.aws_lambda.Function | Lambda function for the Deployer. | | table | aws-cdk-lib.aws_dynamodb.ITable | DynamoDB table used by Router, Deployer, and Release console app. | | routerFunc | aws-cdk-lib.aws_lambda.Function | Lambda function for the Router. | --- ##### `deployerFunc`^Required ```typescript public readonly deployerFunc: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function Lambda function for the Deployer. --- ##### `table`^Required ```typescript public readonly table: ITable; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITable DynamoDB table used by Router, Deployer, and Release console app. --- ##### `routerFunc`^Optional ```typescript public readonly routerFunc: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function Lambda function for the Router. --- ### IMicroAppsTable - *Implemented By:* MicroAppsTable, IMicroAppsTable Represents a MicroAppsTable. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | table | aws-cdk-lib.aws_dynamodb.Table | DynamoDB table used by Router, Deployer, and Release console app. | --- ##### `table`^Required ```typescript public readonly table: Table; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Table DynamoDB table used by Router, Deployer, and Release console app. ---