Class SiteWithEcsBackend

Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend

Example

import { SiteWithEcsBackend, SiteWithEcsBackendProps } '@gradientedge/cdk-utils'
import { Construct } from 'constructs'

class CustomConstruct extends SiteWithEcsBackend {
  constructor(parent: Construct, id: string, props: SiteWithEcsBackendProps) {
    super(parent, id, props)
    this.props = props
    this.id = id
    this.initResources()
  }
}

Hierarchy (View Summary)

CommonConstruct
- SiteWithEcsBackend

Index

Constructors

constructor

Properties

acmManager apiManager appConfigManager cloudFrontManager cloudTrailManager cloudWatchManager codeBuildManager dynamodbManager ecrManager ecsManager efsManager eksManager elasticacheManager eventManager eventTargetManager evidentlyManager fullyQualifiedDomainName iamManager id kmsManager lambdaManager logManager node props resourceNameFormatter route53Manager s3Manager secretsManager sfnManager siteCachePolicy siteCertificate siteCloudfrontFunction siteDistribution siteDomainNames siteEcsBuildArgs siteEcsCluster siteEcsContainerImage siteEcsEnvironment siteEcsListener siteEcsLoadBalancer siteEcsLogGroup siteEcsPolicy siteEcsRole siteEcsService siteEcsTargetGroup siteEcsTaskDefinition siteExternalDomainName siteFileSystem siteFunctionAssociations siteHostedZone siteInternalDomainName siteLogBucket siteOrigin siteOriginRequestPolicy siteOriginResponseHeadersPolicy? siteRegionalCertificate siteSecrets siteVpc snsManager sqsManager ssmManager vpcManager wafManager

Constructors

constructor

new SiteWithEcsBackend(
    parent: Construct,
    id: string,
    props: SiteWithEcsBackendProps,
): SiteWithEcsBackend
Parameters
- parent: Construct
  the parent construct
- id: string
  scoped id of the resource
- props: SiteWithEcsBackendProps
  the site with ECS backend properties
Returns SiteWithEcsBackend
Overrides CommonConstruct.constructor
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:128

Properties

acmManager

acmManager: AcmManager

Manager for AWS Certificate Manager operations

apiManager

apiManager: ApiManager

Manager for API Gateway operations

appConfigManager

appConfigManager: AppConfigManager

Manager for AWS AppConfig operations

cloudFrontManager

cloudFrontManager: CloudFrontManager

Manager for CloudFront distribution operations

cloudTrailManager

cloudTrailManager: CloudTrailManager

Manager for CloudTrail operations

cloudWatchManager

cloudWatchManager: CloudWatchManager

Manager for CloudWatch operations

codeBuildManager

codeBuildManager: CodeBuildManager

Manager for AWS CodeBuild operations

dynamodbManager

dynamodbManager: DynamodbManager

Manager for DynamoDB operations

ecrManager

ecrManager: EcrManager

Manager for Elastic Container Registry operations

ecsManager

ecsManager: EcsManager

Manager for Elastic Container Service operations

efsManager

efsManager: EfsManager

Manager for Elastic File System operations

eksManager

eksManager: EksManager

Manager for Elastic Kubernetes Service operations

elasticacheManager

elasticacheManager: ElastiCacheManager

Manager for ElastiCache operations

eventManager

eventManager: EventManager

Manager for EventBridge operations

eventTargetManager

eventTargetManager: EventTargetManager

Manager for EventBridge target operations

evidentlyManager

evidentlyManager: EvidentlyManager

Manager for CloudWatch Evidently operations

fullyQualifiedDomainName

fullyQualifiedDomainName: string

The fully qualified domain name resolved from domainName and subDomain

iamManager

iamManager: IamManager

Manager for IAM operations

id

id: string

The scoped id of this construct

kmsManager

kmsManager: KmsManager

Manager for KMS operations

lambdaManager

lambdaManager: LambdaManager

Manager for Lambda operations

logManager

logManager: LogManager

Manager for CloudWatch Logs operations

`Readonly`node

node: Node

The tree node.

props

props: SiteWithEcsBackendProps

The site with ECS backend properties

resourceNameFormatter

resourceNameFormatter: ResourceNameFormatter

Utility for formatting resource names with prefix/suffix conventions

route53Manager

route53Manager: Route53Manager

Manager for Route53 operations

s3Manager

s3Manager: S3Manager

Manager for S3 operations

secretsManager

secretsManager: SecretsManager

Manager for Secrets Manager operations

sfnManager

sfnManager: SfnManager

Manager for Step Functions operations

siteCachePolicy

siteCachePolicy: CachePolicy

The CloudFront cache policy

siteCertificate

siteCertificate: ICertificate

The global (edge) SSL/TLS certificate

siteCloudfrontFunction

siteCloudfrontFunction: IFunction

The CloudFront function attached to the distribution

siteDistribution

siteDistribution: Distribution

The CloudFront distribution for the site

siteDomainNames

siteDomainNames: string[]

The list of domain names associated with the CloudFront distribution

siteEcsBuildArgs

siteEcsBuildArgs: any = {}

Docker build arguments for the ECS container image

siteEcsCluster

siteEcsCluster: Cluster

The ECS cluster

siteEcsContainerImage

siteEcsContainerImage: AssetImage

The Docker container image for the ECS task

siteEcsEnvironment

siteEcsEnvironment: { [key: string]: string }

The environment variables passed to the ECS container

siteEcsListener

siteEcsListener: ApplicationListener

The Application Load Balancer listener

siteEcsLoadBalancer

siteEcsLoadBalancer: ApplicationLoadBalancer

The Application Load Balancer

siteEcsLogGroup

siteEcsLogGroup: LogGroup

The CloudWatch log group for ECS task logs

siteEcsPolicy

siteEcsPolicy: PolicyDocument

The IAM policy for the ECS task execution role

siteEcsRole

siteEcsRole: Role

The IAM role for the ECS task execution

siteEcsService

siteEcsService: FargateService

The ECS Fargate service

siteEcsTargetGroup

siteEcsTargetGroup: ApplicationTargetGroup

The ALB target group

siteEcsTaskDefinition

siteEcsTaskDefinition: FargateTaskDefinition

The ECS Fargate task definition

siteExternalDomainName

siteExternalDomainName: string

The external domain name exposed to end users via CloudFront

siteFileSystem

siteFileSystem: FileSystem

The EFS file system for persistent storage

siteFunctionAssociations

siteFunctionAssociations: FunctionAssociation[]

The CloudFront function associations for the distribution behaviours

siteHostedZone

siteHostedZone: IHostedZone

The Route53 hosted zone for the site domain

siteInternalDomainName

siteInternalDomainName: string

The internal domain name used by the ECS load balancer

siteLogBucket

siteLogBucket: IBucket

The S3 bucket used for ALB and CloudFront access logs

siteOrigin

siteOrigin: HttpOrigin

The HTTP origin pointing to the ECS backend

siteOriginRequestPolicy

siteOriginRequestPolicy: OriginRequestPolicy

The CloudFront origin request policy

`Optional`siteOriginResponseHeadersPolicy

siteOriginResponseHeadersPolicy?: ResponseHeadersPolicy

The CloudFront response headers policy

siteRegionalCertificate

siteRegionalCertificate: ICertificate

The regional SSL/TLS certificate

siteSecrets

siteSecrets: any

The resolved secrets from SecretsManager

siteVpc

siteVpc: IVpc

The VPC for the ECS cluster

snsManager

snsManager: SnsManager

Manager for SNS operations

sqsManager

sqsManager: SqsManager

Manager for SQS operations

ssmManager

ssmManager: SsmManager

Manager for Systems Manager operations

vpcManager

vpcManager: VpcManager

Manager for VPC operations

wafManager

wafManager: WafManager

Manager for WAF operations

Methods

`Protected`addCfnOutput

addCfnOutput(
    id: string,
    value: string,
    description?: string,
    overrideId?: boolean,
): CfnOutput
Parameters
- id: string
  scoped id of the resource
- value: string
  the value of the exported output
- Optionaldescription: string
  optional description for the output
- overrideId: boolean = true
  Flag which indicates whether to override the default logical id of the output
Returns CfnOutput
Inherited from CommonConstruct.addCfnOutput
- Defined in packages/aws/src/common/construct.ts:171

`Protected`createDistribution

createDistribution(): void
Method to create Site distribution

Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:614

`Protected`createEcsBuildArgs

createEcsBuildArgs(): void
Method to create docker build arguments for ECS Image step

Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:320

`Protected`createEcsCluster

createEcsCluster(): void
Method to create an ECS cluster

Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:301

`Protected`createEcsContainerImage

createEcsContainerImage(): void
Method to create container image for ECS task

Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:327

`Protected`createEcsEnvironment

createEcsEnvironment(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:290

`Protected`createEcsLogGroup

createEcsLogGroup(): void
Method to create log group used by ECS task

Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:313

`Protected`createEcsPolicy

createEcsPolicy(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:274

`Protected`createEcsRole

createEcsRole(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:283

`Protected`createEcsService

createEcsService(): void
Method to create Application Load balanced ECS Fargate Service

Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:336

`Protected`createNetworkMappings

createNetworkMappings(): void
Method to create Route53 records for distribution

Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:631

`Protected`createResponseHeaderPolicy

createResponseHeaderPolicy(
props: SiteResponseHeadersPolicyProps,
): ResponseHeadersPolicy | undefined
Parameters
- props: SiteResponseHeadersPolicyProps
  the response headers policy properties
Returns ResponseHeadersPolicy | undefined
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:541

`Protected`createSiteCachePolicy

createSiteCachePolicy(
id: string,
siteCachePolicy: SiteCachePolicyProps,
): CachePolicy
Parameters
- id: string
  scoped id of the resource
- siteCachePolicy: SiteCachePolicyProps
  the cache policy properties
Returns CachePolicy
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:487

`Protected`createSiteCloudfrontFunction

createSiteCloudfrontFunction(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:587

`Protected`createSiteLogBucket

createSiteLogBucket(): void
Method to create log bucket for site distribution

Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:478

`Protected`createSiteOrigin

createSiteOrigin(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:576

`Protected`createSiteOriginCachePolicy

createSiteOriginCachePolicy(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:506

`Protected`createSiteOriginRequestPolicy

createSiteOriginRequestPolicy(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:517

`Protected`createSiteOriginResponseHeadersPolicy

createSiteOriginResponseHeadersPolicy(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:565

`Protected`invalidateDistributionCache

invalidateDistributionCache(): void
Method to invalidation the cloudfront distribution cache after a deployment

Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:645

isDevelopmentStage

isDevelopmentStage(): boolean
Returns boolean
Inherited from CommonConstruct.isDevelopmentStage
- Defined in packages/aws/src/common/construct.ts:188

isProductionStage

isProductionStage(): boolean
Returns boolean
Inherited from CommonConstruct.isProductionStage
- Defined in packages/aws/src/common/construct.ts:206

isTestStage

isTestStage(): boolean
Returns boolean
Inherited from CommonConstruct.isTestStage
- Defined in packages/aws/src/common/construct.ts:194

isUatStage

isUatStage(): boolean
Returns boolean
Inherited from CommonConstruct.isUatStage
- Defined in packages/aws/src/common/construct.ts:200

`Protected`resolveCertificate

resolveCertificate(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:178

`Protected`resolveGlobalCertificate

resolveGlobalCertificate(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:186

`Protected`resolveHostedZone

resolveHostedZone(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:167

`Protected`resolveRegionalCertificate

resolveRegionalCertificate(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:209

`Protected`resolveSiteDomainNames

resolveSiteDomainNames(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:239

`Protected`resolveSiteFunctionAssociations

resolveSiteFunctionAssociations(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:600

`Protected`resolveSiteSecrets

resolveSiteSecrets(): void
Returns void
- Defined in packages/aws/src/construct/site-with-ecs-backend/main.ts:234

toString

toString(): string
Returns a string representation of this construct.

Returns string
Inherited from CommonConstruct.toString
- Defined in node_modules/.pnpm/constructs@10.6.0/node_modules/constructs/lib/construct.d.ts:314

with

with(...mixins: IMixin[]): IConstruct
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.
Parameters
- ...mixins: IMixin[]
  The mixins to apply
Returns IConstruct
This construct for chaining
Inherited from CommonConstruct.with
- Defined in node_modules/.pnpm/constructs@10.6.0/node_modules/constructs/lib/construct.d.ts:310

`Static`isConstruct

isConstruct(x: any): x is Construct
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.
Parameters
- x: any
  Any object
Returns x is Construct
true if x is an object created from a class which extends Construct.
Inherited from CommonConstruct.isConstruct
- Defined in node_modules/.pnpm/constructs@10.6.0/node_modules/constructs/lib/construct.d.ts:285

Class SiteWithEcsBackend

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SiteWithEcsBackend

Properties

acmManager

apiManager

appConfigManager

cloudFrontManager

cloudTrailManager

cloudWatchManager

codeBuildManager

dynamodbManager

ecrManager

ecsManager

efsManager

eksManager

elasticacheManager

eventManager

eventTargetManager

evidentlyManager

fullyQualifiedDomainName

iamManager

id

kmsManager

lambdaManager

logManager

Readonlynode

props

resourceNameFormatter

route53Manager

s3Manager

secretsManager

sfnManager

siteCachePolicy

siteCertificate

siteCloudfrontFunction

siteDistribution

siteDomainNames

siteEcsBuildArgs

siteEcsCluster

siteEcsContainerImage

siteEcsEnvironment

siteEcsListener

siteEcsLoadBalancer

siteEcsLogGroup

siteEcsPolicy

siteEcsRole

siteEcsService

siteEcsTargetGroup

siteEcsTaskDefinition

siteExternalDomainName

siteFileSystem

siteFunctionAssociations

siteHostedZone

siteInternalDomainName

siteLogBucket

siteOrigin

siteOriginRequestPolicy

OptionalsiteOriginResponseHeadersPolicy

siteRegionalCertificate

siteSecrets

siteVpc

snsManager

sqsManager

ssmManager

vpcManager

wafManager

Methods

ProtectedaddCfnOutput

Parameters

Returns CfnOutput

ProtectedcreateDistribution

`Readonly`node

`Optional`siteOriginResponseHeadersPolicy

`Protected`addCfnOutput

`Protected`createDistribution

`Protected`createEcsBuildArgs

`Protected`createEcsCluster

`Protected`createEcsContainerImage

`Protected`createEcsEnvironment

`Protected`createEcsLogGroup

`Protected`createEcsPolicy

`Protected`createEcsRole

`Protected`createEcsService

`Protected`createNetworkMappings

`Protected`createResponseHeaderPolicy

`Protected`createSiteCachePolicy

`Protected`createSiteCloudfrontFunction

`Protected`createSiteLogBucket

`Protected`createSiteOrigin

`Protected`createSiteOriginCachePolicy

`Protected`createSiteOriginRequestPolicy

`Protected`createSiteOriginResponseHeadersPolicy

`Protected`createVpc

`Protected`determineFullyQualifiedDomain

`Protected`invalidateDistributionCache

`Protected`resolveCertificate

`Protected`resolveGlobalCertificate

`Protected`resolveHostedZone

`Protected`resolveRegionalCertificate

`Protected`resolveSiteDomainNames

`Protected`resolveSiteFunctionAssociations

`Protected`resolveSiteSecrets