Class Platform`Abstract`

Helper class for resolving Platform-related SSM parameters and resources like VPC and ALBs

Index

Constructors

Methods

alb hostedZone vpc vpcFromLookup

Constructors

constructor

new Platform(): Platform
Returns Platform

Methods

`Static`alb

alb(scope: Construct, id: string, albName: string): IApplicationLoadBalancer
Return an "imported" ALB by its name. This method relies on SSM parameters provided by the Cloud Foundations (/platform/alb/*) that are passed directly to CloudFormation - cdk does not lookup values in synthesis time.
Parameters
- scope: Construct
  Parent construct
- id: string
  Logical ID of the ALB construct
- albName: string
  Logical name of the ALB, component of the respective SSM parameter, e.g. /platform/alb/<albName>/*
Returns IApplicationLoadBalancer
Imported ALB
- Defined in platform.ts:101

`Static`hostedZone

hostedZone(scope: Construct, id: string, zoneName: string): IHostedZone
Parameters
- scope: Construct
  Parent construct
- id: string
  Logical ID of the Hosted Zone construct
- zoneName: string
  name of hosted zone, can be derived from <environment>.zarhq.dev
Returns IHostedZone
Imported HostedZone
- Defined in platform.ts:125

`Static`vpc

vpc(
    scope: Construct,
    id: string,
    vpcName: string,
    usePublic?: boolean,
    useIsolated?: boolean,
): IVpc
Return an "imported" VPC by its name. This method relies on SSM parameters provided by the Cloud Foundations (/platform/vpc/*) that are passed directly to CloudFormation - cdk does not lookup values in synthesis time.

Note: This method automatically acknowledges VPC warnings related to token-based list attributes, which are expected when importing VPCs via SSM parameters.
Parameters
- scope: Construct
  Parent construct
- id: string
  Logical ID of the VPC construct
- vpcName: string
  Logical name of the VPC, component of the respective SSM parameter, e.g. /platform/vpc/<vpcName>/VpcId
- OptionalusePublic: boolean
  Whether public subnets should also be loaded
- OptionaluseIsolated: boolean
  Whether isolated subnets should also be loaded
Returns IVpc
- Defined in platform.ts:25

`Static`vpcFromLookup

vpcFromLookup(scope: Construct, id: string, vpcName: string): IVpc
Look up a VPC by name in the respective account and return corresponding construct.

If this method is used, to be able to synthesize the stack locally, AWS CLI must be authenticated to the respective AWS account so CDK can assume the lookup roles in the respective account in order to do the lookups.
Parameters
- scope: Construct
  Parent construct
- id: string
  Logical ID of the VPC construct
- vpcName: string
  Name of the VPC (the actual "Name" tag)
Returns IVpc
- Defined in platform.ts:86