Setting Up Cdk App

2. Create Shared Infrastructure

The Shared struct holds resources shared across all deployments in a region. Access config values anywhere in the construct tree using scope-based functions:

type Shared struct {
	Bucket     awss3.Bucket
	HostedZone awsroute53.IHostedZone
}

func NewShared(stack awscdk.Stack) *Shared {
	bucket := awss3.NewBucket(stack, jsii.String("SharedBucket"), &awss3.BucketProps{
		Versioned: jsii.Bool(true),
	})
	
	// Access config deep in construct tree - no need to pass *Config explicitly
	zone := awsroute53.HostedZone_FromLookup(stack, jsii.String("Zone"), &awsroute53.HostedZoneProviderProps{
		DomainName: agcdkutil.BaseDomainNamePtr(stack),
	})
	
	return &Shared{Bucket: bucket, HostedZone: zone}
}

3. Create Deployment Infrastructure

The Deployment struct holds resources specific to each deployment (Dev, Stag, Prod):

type Deployment struct{}

func NewDeployment(stack awscdk.Stack, shared *Shared, deploymentIdent string) *Deployment {
	// Access config anywhere in the construct tree
	if agcdkutil.IsPrimaryRegion(stack, *stack.Region()) {
		// Primary region specific setup
	}
	
	// Or get the full Config if needed
	cfg := agcdkutil.ConfigFromScope(stack)
	_ = cfg.AllRegions()
	
	return &Deployment{}
}

4. Configure cdk.json

Create cdk.json with context values matching your prefix:

{
  "app": "go mod download && go run cdk.go",
  "context": {
    "myapp-qualifier": "myapp",
    "myapp-primary-region": "us-east-1",
    "myapp-secondary-regions": ["eu-west-1"],
    "myapp-region-ident-us-east-1": "use1",
    "myapp-region-ident-eu-west-1": "euw1",
    "myapp-deployments": ["Dev", "Stag", "Prod"],
    "myapp-base-domain-name": "example.com"
  }
}

Stack Naming and Dependencies

SetupApp creates stacks with automatic naming and dependency management:

Example with qualifier myapp and region acronym use1:

• myappUse1Shared
• myappUse1Dev
• myappUse1Prod

Lambda Bundling

Use ReproducibleGoBundling() for Lambda functions to ensure identical builds:

awscdklambdagoalpha.NewGoFunction(stack, jsii.String("Handler"), &awscdklambdagoalpha.GoFunctionProps{
	Entry:    jsii.String("./cmd/handler"),
	Bundling: agcdkutil.ReproducibleGoBundling(),
})

API Reference

Core Functions

Scope-Based Convenience Functions

These functions retrieve Config from the construct tree automatically, providing ergonomic access deep in construct trees:

Config Methods

When you have a *Config reference (via ConfigFromScope), these methods are available:

Deprecated Functions

These functions read context without upfront validation. Use the scope-based functions instead:

Deployment Authorization

The DeployersGroup in AppConfig controls who can deploy to restricted environments:

• Users in the deployers group can deploy to all environments
• Other users can only deploy to non-restricted environments (e.g., Dev)
• Set RestrictedDeployments to environments requiring elevated access

Pass deployer groups via context during deploy:

cdk deploy --context myapp-deployer-groups="myapp-deployers other-group"