Package: aws-cdk-microservice
aws-cdk-microserviceaws-cdk-microservice construct library is an open-source extension of the AWS Cloud Development Kit (AWS CDK) to deploy configurable microservice infra and its individual components in less than 50 lines of code and human readable configuration which can be managed by pull requests!A typical microservice architecture on AWS looks like:Using cdk a microservice can be deployed using the following sample code snippet:import{Stack,StackProps}from'@aws-cdk/core';import{Construct}from'constructs';import{MicroService}from'@smallcase/aws-cdk-microservice';import{App}from'@aws-cdk/core';exportclassUnknownAPIStackDevextendsStack{constructor(scope:Construct,id:string,props?:StackProps){super(scope,id,props);newMicroService(this,'test',{appName:'test',env:'prod',asgMaxSize:'1',asgMinSize:'1',diskSize:20,instanceLabels:[{key:'SUDOERS_GROUPS_TAG',propagateAtLaunch:true,value:'Developers',},],instanceType:'t3.micro',vpc:'vpc-1234567',role:{type:'existing',roleArn:'arn:aws:iam::123456789233:instance-profile/API-DEV',},sshKey:'master-dev',subnets:['subnet-12345678','subnet-123456789'],tcpRules:[{sourceSG:'sg-12345678',description:'ssh rule',port:22,},{sourceSG:'sg-987654321',description:'from load balancer',port:8000,},],networkProps:[{healthCheckPath:'/health',host:'abc-test-123.smallcase.com',lbArn:'arn:aws:elasticloadbalancing:ap-south-1:123456789233:loadbalancer/app/API-DEV-External',sslEnabled:false,port:8000,protocol:'HTTP',zoneName:'smallcase.com',zoneId:'1234567891011'},],createCodedeployApplication:true,});}}newUnknownAPIStackDev(app,'UnknownAPIStackDev',{env:{account:'12345678910',region:'ap-south-1'},});app.synth()Please referhereto check how to use individual resource constructs.Install using NPM:npm install @smallcase/aws-cdk-microserviceUsing yarnyarn add @smallcase/aws-cdk-microserviceConfiguration helperPropertyTypeDefaultDescriptionappNamestringName of the application to be deployedapplicationType?stringnewType of application, new or existing, if existing, codedeploy will skip it's application creation and create a deployment group in existing application.asgMaxSize?number2Max ASG scale sizeasgMinSize?number1Min ASG scale sizeenv?stringdevelopmentApplication environment nameinstanceLabels?CfnAutoScalingGroup.TagPropertyProperty[][]Tags to apply to the stackhealthCheckPath?string/healthHealth check path for target groupport?numberundefinedPort on which application is running. If not passed, target group will not be createdprotocol?string (HTTP/HTTPS/GRPC)HTTPService protocoldiskSize?number8GBSize of root volume for launch templatevpcstringVPC in which application infra is to be deployedrole?stringRole ARN which is to be used with launch templatetcpRulesIngressRule[][]TCP Rules which are to be applied to the security groupsubnetsstring[]Subnets in which subnets are to be deployedsslEnabled?booleanfalseWhether to use HTTPS ALB listener, or HTTP ALB listenerhost?stringDNS name, for example abc.xyz.com. Won't be created if TG is not created,lbArn?stringLoad balancer arn for application load balancingsshKeystringThe ssh key pair name which is to be useddiskType?string (GP2/GP3/IO1/IO2)GP3Type of disk to be usedcreateCodedeployApplication?booleanfalseWhether to create a codedeploy application and a deployment group for current ENV passed, if applicationType is new, this will not create an application but will create a new deployment group in the same application name, will throw an error if not found.deploymentPolicies?string[][]Deployment group policies which are to be passed, there are major policies already attached which will allow usage of S3 and triggering codedeploy agents on instances.Bootstrap the environmentcdk bootstrapCheck the changed which are to be deployed~ -> cdk diff
Stack my-stack-dev
...
IAM Policy Changes
┌───┬──────────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────┐
│   │ Resource                                                                     │ Managed Policy ARN                                                 │
├───┼──────────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────┤
│ + │ ${UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-ASG-stackRole} │ arn:aws:iam::aws:policy/service-role/AmazonEC2SpotFleetTaggingRole │
│ + │ ${UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-ASG-stackRole} │ arn:aws:iam::aws:policy/ReadOnlyAccess                             │
│ + │ ${UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-ASG-stackRole} │ arn:aws:iam::aws:policy/service-role/AmazonEC2RoleforSSM           │
│ + │ ${UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-ASG-stackRole} │ arn:aws:iam::aws:policy/AmazonEC2FullAccess                        │
└───┴──────────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────┘
Security Group Changes
┌───┬─────────────────────────────────────────────────────────────────────────────────────┬─────┬────────────┬─────────────────┐
│   │ Group                                                                               │ Dir │ Protocol   │ Peer            │
├───┼─────────────────────────────────────────────────────────────────────────────────────┼─────┼────────────┼─────────────────┤
│ + │ ${UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-ASG-stack-sg.GroupId} │ In  │ TCP 22     │ sg-12346578     │
│ + │ ${UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-ASG-stack-sg.GroupId} │ Out │ Everything │ Everyone (IPv4) │
└───┴─────────────────────────────────────────────────────────────────────────────────────┴─────┴────────────┴─────────────────┘
(NOTE: There may be security-related changes not in this list. See https://github.com/aws/aws-cdk/issues/1299)

Resources
[+] AWS::EC2::SecurityGroup UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-ASG-stack-sg UnknownAPIdevelopmentUnknownAPIasdevelopmentUnknownAPIASGstacksg858F9DBC
[+] AWS::EC2::SecurityGroupIngress UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-ASG-stack-sg/from mystackdevUnknownAPIdevelopmentUnknownAPIassgf9c56492221D098D02:22 UnknownAPIdevelopmentUnknownAPIasdevelopmentUnknownAPIASGstacksgfrommystackdevUnknownAPIdevelopmentUnknownAPIassgf9c56492221D098D0222498F0E3E
[+] AWS::IAM::Role UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-ASG-stackRole UnknownAPIdevelopmentUnknownAPIasdevelopmentUnknownAPIASGstackRole3CEFE0B7
[+] AWS::IAM::Policy UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-ASG-stackRole/DefaultPolicy UnknownAPIdevelopmentUnknownAPIasdevelopmentUnknownAPIASGstackRoleDefaultPolicy8F61E954
[+] AWS::IAM::InstanceProfile UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-LT/Profile UnknownAPIdevelopmentUnknownAPIasdevelopmentUnknownAPILTProfileC84DF85A
[+] AWS::EC2::LaunchTemplate UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-LT UnknownAPIdevelopmentUnknownAPIasdevelopmentUnknownAPILT3B54AB26
[+] AWS::ElasticLoadBalancingV2::TargetGroup UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-TG UnknownAPIdevelopmentUnknownAPIasdevelopmentUnknownAPITG141FD907
[+] AWS::AutoScaling::AutoScalingGroup UnknownAPI/development-UnknownAPI-as/development-UnknownAPI-ASG UnknownAPIdevelopmentUnknownAPIasdevelopmentUnknownAPIASGEC1B4F9C
[+] AWS::IAM::Role UnknownAPI/UnknownAPI-deployment-group-role UnknownAPIUnknownAPIdeploymentgrouprole6E048442
[+] AWS::IAM::Policy UnknownAPI/UnknownAPI-deployment-group-role/DefaultPolicy UnknownAPIUnknownAPIdeploymentgrouproleDefaultPolicy176FEC37
[+] AWS::CodeDeploy::Application UnknownAPI/development-UnknownAPI-cd/UnknownAPI-development UnknownAPIdevelopmentUnknownAPIcdUnknownAPIdevelopment72A04EEC
[+] AWS::CodeDeploy::DeploymentGroup UnknownAPI/development-UnknownAPI-cd/development UnknownAPIdevelopmentUnknownAPIcddevelopmentC502CFADthis is a trimmed output.Deploy using~ -> cdk deploy