Refined the template

Author: snjkumar23

CHANGELOG.MD

@@ -2,19 +2,6 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [1.2.0] - 2022-09-30
-
-### Changed
-- #2: better exception handling
-- #4: better cfn response
-- bump python runtime to 3.9
-- remove software not needed by default
-## [1.1.0] - 2020-11-11
-
-### Changed
-- bump terraform version to 0.13.5
-- add parameter and bootstrap code to resize the cloud9 system volume.
-
 ## [1.0.0] - inital release
 
 ### inital version

README.md

@@ -1,7 +1,7 @@
 ## Cloud 9 Bootstrapping 
 
 ### Summary
-This example Cloudformation Deployment shows how to deploy an AWS Cloud9 Environment for yourself or team members and run an automated bootstrap so you can install software components needed on the fly. 
+This Cloudformation Deployment shows how to deploy an AWS Cloud9 Environment for yourself or team members and run an automated bootstrap so you can install software components needed on the fly. 
 This is usefull for workshops, unified deployments, etc. 
 
 you may use the template directly or leverage the bash shell script for deployment
@@ -11,10 +11,10 @@ There are a few parameters you might want to adjust.
 
 | Parameter Name | Description | 
 | ------------- | ------------- | 
-| ExampleC9InstanceType | Example Cloud9 EC2 instance type |
-| ExampleC9EnvType | Environment Type. For yourself or to be deployed to a team member 3rd person by you? | 
-| ExampleOwnerArn | if you selected "3rd person" when choosing ExampleC9EnvType please add the OwnerARN of the User or Role |
-| ExampleC9InstanceVolumeSize | The size of the System Volume for the Cloud9 instance |
+| C9InstanceType |  Cloud9 EC2 instance type |
+| C9EnvType | Environment Type. For yourself or to be deployed to a team member 3rd person by you? | 
+| OwnerArn | if you selected "3rd person" when choosing C9EnvType please add the OwnerARN of the User or Role |
+| C9InstanceVolumeSize | The size of the System Volume for the Cloud9 instance |
 
 ### Some tech Details
 This deployment uses Cloudformation to deploy Cloud9 

example_instancestack.yaml cloud9_instancestack.yaml

@@ -3,8 +3,8 @@ AWSTemplateFormatVersion: '2010-09-09'
 Description: AWS CloudFormation template for dynamic Cloud 9 setups. Creates a Cloud9
   bootstraps the instance.
 Parameters:
-  ExampleC9InstanceType:
-    Description: Example Cloud9 instance type
+  C9InstanceType:
+    Description: Cloud9 instance type
     Type: String
     Default: t3.small
     AllowedValues:
@@ -13,34 +13,41 @@ Parameters:
       - t3.small
       - t3.medium
     ConstraintDescription: Must be a valid Cloud9 instance type
-  ExampleC9EnvType: 
+  C9EnvType: 
     Description: Environment type.
     Default: self
     Type: String
     AllowedValues: 
       - self
       - 3rdParty
     ConstraintDescription: must specify self or 3rdParty.
-  ExampleOwnerArn: 
+  OwnerArn: 
     Type: String
     Description: The Arn of the Cloud9 Owner to be set if 3rdParty deployment.
     Default: ""
-  ExampleC9InstanceVolumeSize: 
+  C9InstanceVolumeSize: 
     Type: Number
     Description: The Size in GB of the Cloud9 Instance Volume. 
     Default: 15
-
+  Project: 
+    Type: String
+    Description: Project Name.
+    Default: ""
+  ShutdownTimeout:
+    Type: Number
+    Description: Inactivity time before shutting down the instance in seconds
+    Default: 3600
 Conditions: 
-  Create3rdPartyResources: !Equals [ !Ref ExampleC9EnvType, 3rdParty ]
+  Create3rdPartyResources: !Equals [ !Ref C9EnvType, 3rdParty ]
 
 Resources:
 ################## PERMISSIONS AND ROLES #################
-  ExampleC9Role:
+  C9Role:
     Type: AWS::IAM::Role
     Properties:
       Tags:
         - Key: Environment
-          Value: AWS Example
+          Value: AWS
       AssumeRolePolicyDocument:
         Version: '2012-10-17'
         Statement:
@@ -55,7 +62,7 @@ Resources:
       - arn:aws:iam::aws:policy/AdministratorAccess
       Path: "/"
 
-  ExampleC9LambdaExecutionRole:
+  C9LambdaExecutionRole:
     Type: AWS::IAM::Role
     Properties:
       AssumeRolePolicyDocument:
@@ -72,7 +79,7 @@ Resources:
       - PolicyName:
           Fn::Join:
           - ''
-          - - ExampleC9LambdaPolicy-
+          - - C9LambdaPolicy-
             - Ref: AWS::Region
         PolicyDocument:
           Version: '2012-10-17'
@@ -99,45 +106,45 @@ Resources:
 
 ################## LAMBDA BOOTSTRAP FUNCTION ################
 
-  ExampleC9BootstrapInstanceLambda:
+  C9BootstrapInstanceLambda:
     Description: Bootstrap Cloud9 instance
-    Type: Custom::ExampleC9BootstrapInstanceLambda
+    Type: Custom::C9BootstrapInstanceLambda
     DependsOn:
-    - ExampleC9BootstrapInstanceLambdaFunction
-    - ExampleC9Instance
-    - ExampleC9InstanceProfile
-    - ExampleC9LambdaExecutionRole
+    - C9BootstrapInstanceLambdaFunction
+    - C9Instance
+    - C9InstanceProfile
+    - C9LambdaExecutionRole
     Properties:
       Tags:
         - Key: Environment
-          Value: AWS Example
+          Value: AWS
       ServiceToken:
         Fn::GetAtt:
-        - ExampleC9BootstrapInstanceLambdaFunction
+        - C9BootstrapInstanceLambdaFunction
         - Arn
       REGION:
         Ref: AWS::Region
       StackName:
         Ref: AWS::StackName
       EnvironmentId:
-        Ref: ExampleC9Instance
+        Ref: C9Instance
       LabIdeInstanceProfileName:
-        Ref: ExampleC9InstanceProfile
+        Ref: C9InstanceProfile
       LabIdeInstanceProfileArn:
         Fn::GetAtt:
-        - ExampleC9InstanceProfile
+        - C9InstanceProfile
         - Arn
 
-  ExampleC9BootstrapInstanceLambdaFunction:
+  C9BootstrapInstanceLambdaFunction:
     Type: AWS::Lambda::Function
     Properties:
       Tags:
         - Key: Environment
-          Value: AWS Example
+          Value: AWS
       Handler: index.lambda_handler
       Role:
         Fn::GetAtt:
-        - ExampleC9LambdaExecutionRole
+        - C9LambdaExecutionRole
         - Arn
       Runtime: python3.9
       MemorySize: 256
@@ -202,7 +209,7 @@ Resources:
                   finally:
                       cfnresponse.send(event, context, status, responseData, 'CustomResourcePhysicalID')
 ################## SSM BOOTSRAP HANDLER ###############
-  ExampleC9OutputBucket:
+  C9OutputBucket:
     Type: AWS::S3::Bucket
     DeletionPolicy: Delete
     Properties: 
@@ -213,20 +220,20 @@ Resources:
           - ServerSideEncryptionByDefault:
               SSEAlgorithm: AES256
 
-  ExampleC9SSMDocument: 
+  C9SSMDocument: 
     Type: AWS::SSM::Document
     Properties: 
       Tags:
         - Key: Environment
-          Value: AWS Example
+          Value: AWS
       DocumentType: Command
       DocumentFormat: YAML
       Content: 
         schemaVersion: '2.2'
         description: Bootstrap Cloud9 Instance
         mainSteps:
         - action: aws:runShellScript
-          name: ExampleC9bootstrap
+          name: C9bootstrap
           inputs:
             runCommand:
             - "#!/bin/bash"
@@ -241,7 +248,7 @@ Resources:
             - echo '=== INSTALL and CONFIGURE default software components ==='
             - sudo -H -u ec2-user bash -c "pip install --user -U boto boto3 botocore awscli"
             - echo '=== Resizing the Instance volume'
-            - !Sub SIZE=${ExampleC9InstanceVolumeSize}
+            - !Sub SIZE=${C9InstanceVolumeSize}
             - !Sub REGION=${AWS::Region}
             - |
               INSTANCEID=$(curl http://169.254.169.254/latest/meta-data/instance-id)
@@ -293,47 +300,48 @@ Resources:
             - FILE=$(mktemp) && echo $FILE && echo '#!/bin/bash' > $FILE && echo 'reboot -f --verbose' >> $FILE && at now + 1 minute -f $FILE
             - echo "Bootstrap completed with return code $?"
 
-  ExampleC9BootstrapAssociation: 
+  C9BootstrapAssociation: 
     Type: AWS::SSM::Association
-    DependsOn: ExampleC9OutputBucket 
+    DependsOn: C9OutputBucket 
     Properties: 
-      Name: !Ref ExampleC9SSMDocument
+      Name: !Ref C9SSMDocument
       OutputLocation: 
         S3Location:
-          OutputS3BucketName: !Ref ExampleC9OutputBucket
+          OutputS3BucketName: !Ref C9OutputBucket
           OutputS3KeyPrefix: bootstrapoutput
       Targets:
         - Key: tag:SSMBootstrap
           Values:
           - Active
 
 ################## INSTANCE #####################
-  ExampleC9InstanceProfile:
+  C9InstanceProfile:
     Type: AWS::IAM::InstanceProfile
     Properties:
       Path: "/"
       Roles:
-      - Ref: ExampleC9Role
+      - Ref: C9Role
 
-  ExampleC9Instance:
+  C9Instance:
     Description: "-"
-    DependsOn: ExampleC9BootstrapAssociation
+    DependsOn: C9BootstrapAssociation
     Type: AWS::Cloud9::EnvironmentEC2
     Properties:
-      Description: AWS Cloud9 instance for Examples
-      AutomaticStopTimeMinutes: 3600
+      Description: AWS Cloud9 instance
+      AutomaticStopTimeMinutes: 
+        Ref: ShutdownTimeout
       InstanceType:
-        Ref: ExampleC9InstanceType
+        Ref: C9InstanceType
       Name:
         Ref: AWS::StackName
-      OwnerArn: !If [Create3rdPartyResources, !Ref ExampleOwnerArn, !Ref "AWS::NoValue" ]
+      OwnerArn: !If [Create3rdPartyResources, !Ref OwnerArn, !Ref "AWS::NoValue" ]
       Tags: 
         - 
           Key: SSMBootstrap
           Value: Active
         - 
           Key: Environment
-          Value: AWS Example
+          Value: AWS
 
 Outputs: 
   Cloud9IDE:
@@ -343,6 +351,6 @@ Outputs:
       - - https://
         - Ref: AWS::Region
         - ".console.aws.amazon.com/cloud9/ide/"
-        - Ref: ExampleC9Instance
+        - Ref: C9Instance
         - "?region="
         - Ref: AWS::Region

example_setup.sh cloud9_setup.sh

@@ -2,9 +2,8 @@
 # Simple bash for Workshop C9 Deployment. 
 # will move towards real automation tools later on
 # created by David Surey, Amazon Web Services
-# [email protected]
 # NOT FOR PRODUCTION USE - Only for Workshop purposes
-C9STACK="ExampleC9"
+C9STACK="C9"
 PROFILE=$2
 REGION=$1 
 WORKSHOPUSER="[email protected]"
@@ -25,6 +24,6 @@ fi
 echo Building $PROFILE C9
 
 # build the c9 environment
-aws cloudformation deploy  --stack-name $C9STACK --capabilities CAPABILITY_IAM --template ./example_instancestack.yaml
+aws cloudformation deploy  --stack-name $C9STACK --capabilities CAPABILITY_IAM --template ./cloud9_instancestack.yaml
 
 exit 0