cdk-code-server 0.0.13__py3-none-any.whl → 1.0.1__py3-none-any.whl

cdk_code_server/__init__.py

@@ -65,17 +65,17 @@ new CodeServer(this, 'CodeServer', {
 
 ## Setup VSCode Server
 
-After the stack is deployed, you can access to the server via EC2 instance connect endpoint(EIC endpoint) and create connection to the VSCode server:
+After the stack is deployed, you can access the server via AWS Systems Manager (SSM) Session Manager by default and start the VSCode server:
 
-### Access to the EC2 instance
+### Access to the EC2 instance (Default: SSM)
 
-Access the EC2 management console in the AWS Console, and connect to your EC2 instance via the EIC Endpoint.
+1. In the AWS Console, go to the EC2 Instances page and select your instance.
+2. Click the "Connect" button, choose "Session Manager", and click "Connect".
+3. Once connected, switch to the ec2-user account:
 
-Select the Instance ID > Connect > EC2 Instance Connect > Connect using EC2 Instance Connect Endpoint > Connect
-
-If the following screen is displayed, you're all set.
-
-![EC2 Instance Connect](./images/console.png)
+```sh
+sudo su --login ec2-user
+```
 
 ### Start the VSCode server
 
@@ -117,6 +117,21 @@ At this point, the GitHub authentication screen may appear again, so press Autho
 Once you open the terminal, you’re all set.
 
 ![VSCode](./images/vscode.png)
+
+---
+
+
+### (Option) Access via EC2 Instance Connect Endpoint (EIC Endpoint)
+
+If the `useInstanceConnectEndpoint` option is set to true, you can connect via the EC2 Instance Connect Endpoint.
+
+1. In the AWS Console, go to the EC2 Instances page and select your instance.
+2. Click the "Connect" button, choose "EC2 Instance Connect", then select "Connect using EC2 Instance Connect Endpoint", and click "Connect".
+3. Once connected, you will see a screen similar to the following:
+
+![EC2 Instance Connect](./images/console.png)
+
+1. Follow the same steps as in the SSM section to start the VSCode server and connect via tunnel.
 '''
 from pkgutil import extend_path
 __path__ = extend_path(__path__, __name__)
@@ -170,6 +185,7 @@ class CodeServer(
         cpu_type: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.AmazonLinuxCpuType] = None,
         instance_type: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.InstanceType] = None,
         policy: typing.Optional[_aws_cdk_aws_iam_ceddda9d.PolicyStatement] = None,
+        use_instance_connect_endpoint: typing.Optional[builtins.bool] = None,
         user_data: typing.Optional[typing.Sequence[builtins.str]] = None,
         volume_size: typing.Optional[jsii.Number] = None,
         vpc: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.IVpc] = None,
@@ -180,6 +196,7 @@ class CodeServer(
         :param cpu_type: The CPU type. Default: - ARM_64
         :param instance_type: The instance type. Default: - C7g.2xlarge
         :param policy: The IAM policy to attach to the instance role. Default: - Allow all actions on all resources
+        :param use_instance_connect_endpoint: Whether to use EC2 instance connect endpoint for instance access. If set to true, it will create an EC2 Instance Connect Endpoint in the VPC. You can access the instance using either EC2 Instance Connect or SSM Session Manager. Default: false - Uses only SSM Session Manager for instance access
         :param user_data: User data to run when launching the instance. Default: - No additional user data
         :param volume_size: The size of the root volume in GiB. Default: 30
         :param vpc: The VPC where the instance will be deployed. Default: - A new VPC will be created
@@ -192,6 +209,7 @@ class CodeServer(
             cpu_type=cpu_type,
             instance_type=instance_type,
             policy=policy,
+            use_instance_connect_endpoint=use_instance_connect_endpoint,
             user_data=user_data,
             volume_size=volume_size,
             vpc=vpc,
@@ -207,6 +225,7 @@ class CodeServer(
         "cpu_type": "cpuType",
         "instance_type": "instanceType",
         "policy": "policy",
+        "use_instance_connect_endpoint": "useInstanceConnectEndpoint",
         "user_data": "userData",
         "volume_size": "volumeSize",
         "vpc": "vpc",
@@ -219,6 +238,7 @@ class CodeServerProps:
         cpu_type: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.AmazonLinuxCpuType] = None,
         instance_type: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.InstanceType] = None,
         policy: typing.Optional[_aws_cdk_aws_iam_ceddda9d.PolicyStatement] = None,
+        use_instance_connect_endpoint: typing.Optional[builtins.bool] = None,
         user_data: typing.Optional[typing.Sequence[builtins.str]] = None,
         volume_size: typing.Optional[jsii.Number] = None,
         vpc: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.IVpc] = None,
@@ -228,6 +248,7 @@ class CodeServerProps:
         :param cpu_type: The CPU type. Default: - ARM_64
         :param instance_type: The instance type. Default: - C7g.2xlarge
         :param policy: The IAM policy to attach to the instance role. Default: - Allow all actions on all resources
+        :param use_instance_connect_endpoint: Whether to use EC2 instance connect endpoint for instance access. If set to true, it will create an EC2 Instance Connect Endpoint in the VPC. You can access the instance using either EC2 Instance Connect or SSM Session Manager. Default: false - Uses only SSM Session Manager for instance access
         :param user_data: User data to run when launching the instance. Default: - No additional user data
         :param volume_size: The size of the root volume in GiB. Default: 30
         :param vpc: The VPC where the instance will be deployed. Default: - A new VPC will be created
@@ -237,6 +258,7 @@ class CodeServerProps:
             check_type(argname="argument cpu_type", value=cpu_type, expected_type=type_hints["cpu_type"])
             check_type(argname="argument instance_type", value=instance_type, expected_type=type_hints["instance_type"])
             check_type(argname="argument policy", value=policy, expected_type=type_hints["policy"])
+            check_type(argname="argument use_instance_connect_endpoint", value=use_instance_connect_endpoint, expected_type=type_hints["use_instance_connect_endpoint"])
             check_type(argname="argument user_data", value=user_data, expected_type=type_hints["user_data"])
             check_type(argname="argument volume_size", value=volume_size, expected_type=type_hints["volume_size"])
             check_type(argname="argument vpc", value=vpc, expected_type=type_hints["vpc"])
@@ -247,6 +269,8 @@ class CodeServerProps:
             self._values["instance_type"] = instance_type
         if policy is not None:
             self._values["policy"] = policy
+        if use_instance_connect_endpoint is not None:
+            self._values["use_instance_connect_endpoint"] = use_instance_connect_endpoint
         if user_data is not None:
             self._values["user_data"] = user_data
         if volume_size is not None:
@@ -281,6 +305,18 @@ class CodeServerProps:
         result = self._values.get("policy")
         return typing.cast(typing.Optional[_aws_cdk_aws_iam_ceddda9d.PolicyStatement], result)
 
+    @builtins.property
+    def use_instance_connect_endpoint(self) -> typing.Optional[builtins.bool]:
+        '''Whether to use EC2 instance connect endpoint for instance access.
+
+        If set to true, it will create an EC2 Instance Connect Endpoint in the VPC.
+        You can access the instance using either EC2 Instance Connect or SSM Session Manager.
+
+        :default: false - Uses only SSM Session Manager for instance access
+        '''
+        result = self._values.get("use_instance_connect_endpoint")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
     @builtins.property
     def user_data(self) -> typing.Optional[typing.List[builtins.str]]:
         '''User data to run when launching the instance.
@@ -334,6 +370,7 @@ def _typecheckingstub__a3dc073ef85aeeab8ffd2fe5c32c737ce76d0e4197f8d84ff2cfe4d4a
     cpu_type: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.AmazonLinuxCpuType] = None,
     instance_type: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.InstanceType] = None,
     policy: typing.Optional[_aws_cdk_aws_iam_ceddda9d.PolicyStatement] = None,
+    use_instance_connect_endpoint: typing.Optional[builtins.bool] = None,
     user_data: typing.Optional[typing.Sequence[builtins.str]] = None,
     volume_size: typing.Optional[jsii.Number] = None,
     vpc: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.IVpc] = None,
@@ -346,6 +383,7 @@ def _typecheckingstub__fb583e2cef71433ccfaa187bf48195bf7085ded509b20a2c01dc80cff
     cpu_type: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.AmazonLinuxCpuType] = None,
     instance_type: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.InstanceType] = None,
     policy: typing.Optional[_aws_cdk_aws_iam_ceddda9d.PolicyStatement] = None,
+    use_instance_connect_endpoint: typing.Optional[builtins.bool] = None,
     user_data: typing.Optional[typing.Sequence[builtins.str]] = None,
     volume_size: typing.Optional[jsii.Number] = None,
     vpc: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.IVpc] = None,

cdk_code_server/_jsii/__init__.py

@@ -32,7 +32,7 @@ import aws_cdk._jsii
 import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
-    "cdk-code-server", "0.0.13", __name__[0:-6], "cdk-code-server@0.0.13.jsii.tgz"
+    "cdk-code-server", "1.0.1", __name__[0:-6], "cdk-code-server@1.0.1.jsii.tgz"
 )
 
 __all__ = [

{cdk_code_server-0.0.13.dist-info → cdk_code_server-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdk-code-server
-Version: 0.0.13
+Version: 1.0.1
 Summary: CDK Construct for a VSCode Server development environment on EC2
 Home-page: https://github.com/badmintoncryer/cdk-code-server.git
 Author: Kazuho CryerShinozuka<malaysia.cryer@gmail.com>
@@ -19,11 +19,11 @@ Classifier: License :: OSI Approved
 Requires-Python: ~=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aws-cdk-lib<3.0.0,>=2.143.0
-Requires-Dist: constructs<11.0.0,>=10.0.5
-Requires-Dist: jsii<2.0.0,>=1.112.0
-Requires-Dist: publication>=0.0.3
-Requires-Dist: typeguard<4.3.0,>=2.13.3
+Requires-Dist: aws-cdk-lib <3.0.0,>=2.143.0
+Requires-Dist: constructs <11.0.0,>=10.0.5
+Requires-Dist: jsii <2.0.0,>=1.113.0
+Requires-Dist: publication >=0.0.3
+Requires-Dist: typeguard <4.3.0,>=2.13.3
 
 # CDK VSCode Server Construct
 
@@ -91,17 +91,17 @@ new CodeServer(this, 'CodeServer', {
 
 ## Setup VSCode Server
 
-After the stack is deployed, you can access to the server via EC2 instance connect endpoint(EIC endpoint) and create connection to the VSCode server:
+After the stack is deployed, you can access the server via AWS Systems Manager (SSM) Session Manager by default and start the VSCode server:
 
-### Access to the EC2 instance
+### Access to the EC2 instance (Default: SSM)
 
-Access the EC2 management console in the AWS Console, and connect to your EC2 instance via the EIC Endpoint.
+1. In the AWS Console, go to the EC2 Instances page and select your instance.
+2. Click the "Connect" button, choose "Session Manager", and click "Connect".
+3. Once connected, switch to the ec2-user account:
 
-Select the Instance ID > Connect > EC2 Instance Connect > Connect using EC2 Instance Connect Endpoint > Connect
-
-If the following screen is displayed, you're all set.
-
-![EC2 Instance Connect](./images/console.png)
+```sh
+sudo su --login ec2-user
+```
 
 ### Start the VSCode server
 
@@ -143,3 +143,18 @@ At this point, the GitHub authentication screen may appear again, so press Autho
 Once you open the terminal, you’re all set.
 
 ![VSCode](./images/vscode.png)
+
+---
+
+
+### (Option) Access via EC2 Instance Connect Endpoint (EIC Endpoint)
+
+If the `useInstanceConnectEndpoint` option is set to true, you can connect via the EC2 Instance Connect Endpoint.
+
+1. In the AWS Console, go to the EC2 Instances page and select your instance.
+2. Click the "Connect" button, choose "EC2 Instance Connect", then select "Connect using EC2 Instance Connect Endpoint", and click "Connect".
+3. Once connected, you will see a screen similar to the following:
+
+![EC2 Instance Connect](./images/console.png)
+
+1. Follow the same steps as in the SSM section to start the VSCode server and connect via tunnel.

cdk_code_server-1.0.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+cdk_code_server/__init__.py,sha256=ABcpjzx8Enzmgh6EfxIukSZq7D022-iuP6elrBXxkv4,17391
+cdk_code_server/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+cdk_code_server/_jsii/__init__.py,sha256=K6NuWvUGymO9z1_6zmNYwqp5OFCJo0ztDj5ZW_ulkF0,1441
+cdk_code_server/_jsii/cdk-code-server@1.0.1.jsii.tgz,sha256=y-C_v9K-8L21iq7Nx19HIeAOXQuX9JfaBHTZ-P-FpFc,1313065
+cdk_code_server-1.0.1.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+cdk_code_server-1.0.1.dist-info/METADATA,sha256=59FFr363zATwsGWq3johkl4GSNmRfUIFCD38rmihXWc,6634
+cdk_code_server-1.0.1.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+cdk_code_server-1.0.1.dist-info/top_level.txt,sha256=UPdb0hVf1P6GpgMW16KwUQ3sBADg2WccQHQeL85PrBU,16
+cdk_code_server-1.0.1.dist-info/RECORD,,

cdk_code_server-0.0.13.dist-info/RECORD

@@ -1,9 +0,0 @@
-cdk_code_server/__init__.py,sha256=OgrsOboDe9XyeSklFj90EnH3cmK7s0urd7hRAzrdQjw,14816
-cdk_code_server/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-cdk_code_server/_jsii/__init__.py,sha256=uur0aaf67C7jzT3xtMX9FQqzl56zEP2Sd7mGH5-RzEg,1443
-cdk_code_server/_jsii/cdk-code-server@0.0.13.jsii.tgz,sha256=0_IoiOQWiI_H61LXOQhBkBbVQJuVRhrR_Nq3rCJdjVE,1311149
-cdk_code_server-0.0.13.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-cdk_code_server-0.0.13.dist-info/METADATA,sha256=0tXd_fNn0TxUawCPNXvkxion62brE_dosyOaZ0FKClI,6080
-cdk_code_server-0.0.13.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
-cdk_code_server-0.0.13.dist-info/top_level.txt,sha256=UPdb0hVf1P6GpgMW16KwUQ3sBADg2WccQHQeL85PrBU,16
-cdk_code_server-0.0.13.dist-info/RECORD,,