@aws-cdk/aws-cloud9-alpha 2.32.0-alpha.0 → 2.34.0-alpha.0

package/.jsii

@@ -8,7 +8,7 @@
     "url": "https://aws.amazon.com"
   },
   "dependencies": {
-    "aws-cdk-lib": "^2.32.0",
+    "aws-cdk-lib": "^2.34.0",
     "constructs": "^10.0.0"
   },
   "dependencyClosure": {
@@ -3024,7 +3024,7 @@
     "stability": "experimental"
   },
   "homepage": "https://github.com/aws/aws-cdk",
-  "jsiiVersion": "1.60.1 (build 2799dc8)",
+  "jsiiVersion": "1.63.0 (build 7c24e36)",
   "keywords": [
     "aws",
     "cdk",
@@ -3045,7 +3045,7 @@
   },
   "name": "@aws-cdk/aws-cloud9-alpha",
   "readme": {
-    "markdown": "# AWS Cloud9 Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\nAWS Cloud9 is a cloud-based integrated development environment (IDE) that lets you write, run, and debug your code with just a\nbrowser. It includes a code editor, debugger, and terminal. Cloud9 comes prepackaged with essential tools for popular\nprogramming languages, including JavaScript, Python, PHP, and more, so you don’t need to install files or configure your\ndevelopment machine to start new projects. Since your Cloud9 IDE is cloud-based, you can work on your projects from your\noffice, home, or anywhere using an internet-connected machine. Cloud9 also provides a seamless experience for developing\nserverless applications enabling you to easily define resources, debug, and switch between local and remote execution of\nserverless applications. With Cloud9, you can quickly share your development environment with your team, enabling you to pair\nprogram and track each other's inputs in real time.\n\n\n## Creating EC2 Environment\n\nEC2 Environments are defined with `Ec2Environment`. To create an EC2 environment in the private subnet, specify\n`subnetSelection` with private `subnetType`.\n\n\n```ts\n// create a cloud9 ec2 environment in a new VPC\nconst vpc = new ec2.Vpc(this, 'VPC', { maxAzs: 3});\nnew cloud9.Ec2Environment(this, 'Cloud9Env', { vpc });\n\n// or create the cloud9 environment in the default VPC with specific instanceType\nconst defaultVpc = ec2.Vpc.fromLookup(this, 'DefaultVPC', { isDefault: true });\nnew cloud9.Ec2Environment(this, 'Cloud9Env2', {\n  vpc: defaultVpc,\n  instanceType: new ec2.InstanceType('t3.large'),\n});\n\n// or specify in a different subnetSelection\nconst c9env = new cloud9.Ec2Environment(this, 'Cloud9Env3', {\n  vpc,\n  subnetSelection: {\n    subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,\n  },\n});\n\n// print the Cloud9 IDE URL in the output\nnew CfnOutput(this, 'URL', { value: c9env.ideUrl });\n```\n\n## Cloning Repositories\n\nUse `clonedRepositories` to clone one or multiple AWS Codecommit repositories into the environment:\n\n```ts\nimport * as codecommit from 'aws-cdk-lib/aws-codecommit';\n\n// create a codecommit repository to clone into the cloud9 environment\nconst repoNew = new codecommit.Repository(this, 'RepoNew', {\n  repositoryName: 'new-repo',\n});\n\n// import an existing codecommit repository to clone into the cloud9 environment\nconst repoExisting = codecommit.Repository.fromRepositoryName(this, 'RepoExisting', 'existing-repo');\n\n// create a new Cloud9 environment and clone the two repositories\ndeclare const vpc: ec2.Vpc;\nnew cloud9.Ec2Environment(this, 'C9Env', {\n  vpc,\n  clonedRepositories: [\n    cloud9.CloneRepository.fromCodeCommit(repoNew, '/src/new-repo'),\n    cloud9.CloneRepository.fromCodeCommit(repoExisting, '/src/existing-repo'),\n  ],\n});\n```\n"
+    "markdown": "# AWS Cloud9 Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\nAWS Cloud9 is a cloud-based integrated development environment (IDE) that lets you write, run, and debug your code with just a\nbrowser. It includes a code editor, debugger, and terminal. Cloud9 comes prepackaged with essential tools for popular\nprogramming languages, including JavaScript, Python, PHP, and more, so you don’t need to install files or configure your\ndevelopment machine to start new projects. Since your Cloud9 IDE is cloud-based, you can work on your projects from your\noffice, home, or anywhere using an internet-connected machine. Cloud9 also provides a seamless experience for developing\nserverless applications enabling you to easily define resources, debug, and switch between local and remote execution of\nserverless applications. With Cloud9, you can quickly share your development environment with your team, enabling you to pair\nprogram and track each other's inputs in real time.\n\n\n## Creating EC2 Environment\n\nEC2 Environments are defined with `Ec2Environment`. To create an EC2 environment in the private subnet, specify\n`subnetSelection` with private `subnetType`.\n\n\n```ts\n// create a cloud9 ec2 environment in a new VPC\nconst vpc = new ec2.Vpc(this, 'VPC', { maxAzs: 3});\nnew cloud9.Ec2Environment(this, 'Cloud9Env', { vpc, imageId: cloud9.ImageId.AMAZON_LINUX_2, });\n\n// or create the cloud9 environment in the default VPC with specific instanceType\nconst defaultVpc = ec2.Vpc.fromLookup(this, 'DefaultVPC', { isDefault: true });\nnew cloud9.Ec2Environment(this, 'Cloud9Env2', {\n  vpc: defaultVpc,\n  instanceType: new ec2.InstanceType('t3.large'),\n  imageId: cloud9.ImageId.AMAZON_LINUX_2,\n});\n\n// or specify in a different subnetSelection\nconst c9env = new cloud9.Ec2Environment(this, 'Cloud9Env3', {\n  vpc,\n  subnetSelection: {\n    subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,\n  },\n  imageId: cloud9.ImageId.AMAZON_LINUX_2,\n});\n\n// print the Cloud9 IDE URL in the output\nnew CfnOutput(this, 'URL', { value: c9env.ideUrl });\n```\n\n## Specifying EC2 AMI\n\nUse `imageId` to specify the EC2 AMI image to be used:\n\n```ts\nconst defaultVpc = ec2.Vpc.fromLookup(this, 'DefaultVPC', { isDefault: true });\nnew cloud9.Ec2Environment(this, 'Cloud9Env2', {\n  vpc: defaultVpc,\n  instanceType: new ec2.InstanceType('t3.large'),\n  imageId: cloud9.ImageId.UBUNTU_18_04,\n});\n```\n\n## Cloning Repositories\n\nUse `clonedRepositories` to clone one or multiple AWS Codecommit repositories into the environment:\n\n```ts\nimport * as codecommit from 'aws-cdk-lib/aws-codecommit';\n\n// create a codecommit repository to clone into the cloud9 environment\nconst repoNew = new codecommit.Repository(this, 'RepoNew', {\n  repositoryName: 'new-repo',\n});\n\n// import an existing codecommit repository to clone into the cloud9 environment\nconst repoExisting = codecommit.Repository.fromRepositoryName(this, 'RepoExisting', 'existing-repo');\n\n// create a new Cloud9 environment and clone the two repositories\ndeclare const vpc: ec2.Vpc;\nnew cloud9.Ec2Environment(this, 'C9Env', {\n  vpc,\n  clonedRepositories: [\n    cloud9.CloneRepository.fromCodeCommit(repoNew, '/src/new-repo'),\n    cloud9.CloneRepository.fromCodeCommit(repoExisting, '/src/existing-repo'),\n  ],\n  imageId: cloud9.ImageId.AMAZON_LINUX_2,\n});\n```\n"
   },
   "repository": {
     "directory": "packages/individual-packages/aws-cloud9",
@@ -3089,7 +3089,7 @@
         "custom": {
           "exampleMetadata": "infused"
         },
-        "example": "import * as codecommit from 'aws-cdk-lib/aws-codecommit';\n\n// create a codecommit repository to clone into the cloud9 environment\nconst repoNew = new codecommit.Repository(this, 'RepoNew', {\n  repositoryName: 'new-repo',\n});\n\n// import an existing codecommit repository to clone into the cloud9 environment\nconst repoExisting = codecommit.Repository.fromRepositoryName(this, 'RepoExisting', 'existing-repo');\n\n// create a new Cloud9 environment and clone the two repositories\ndeclare const vpc: ec2.Vpc;\nnew cloud9.Ec2Environment(this, 'C9Env', {\n  vpc,\n  clonedRepositories: [\n    cloud9.CloneRepository.fromCodeCommit(repoNew, '/src/new-repo'),\n    cloud9.CloneRepository.fromCodeCommit(repoExisting, '/src/existing-repo'),\n  ],\n});",
+        "example": "import * as codecommit from 'aws-cdk-lib/aws-codecommit';\n\n// create a codecommit repository to clone into the cloud9 environment\nconst repoNew = new codecommit.Repository(this, 'RepoNew', {\n  repositoryName: 'new-repo',\n});\n\n// import an existing codecommit repository to clone into the cloud9 environment\nconst repoExisting = codecommit.Repository.fromRepositoryName(this, 'RepoExisting', 'existing-repo');\n\n// create a new Cloud9 environment and clone the two repositories\ndeclare const vpc: ec2.Vpc;\nnew cloud9.Ec2Environment(this, 'C9Env', {\n  vpc,\n  clonedRepositories: [\n    cloud9.CloneRepository.fromCodeCommit(repoNew, '/src/new-repo'),\n    cloud9.CloneRepository.fromCodeCommit(repoExisting, '/src/existing-repo'),\n  ],\n  imageId: cloud9.ImageId.AMAZON_LINUX_2,\n});",
         "stability": "experimental",
         "summary": "The class for different repository providers."
       },
@@ -3097,7 +3097,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "lib/environment.ts",
-        "line": 177
+        "line": 202
       },
       "methods": [
         {
@@ -3107,7 +3107,7 @@
           },
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 184
+            "line": 209
           },
           "name": "fromCodeCommit",
           "parameters": [
@@ -3147,7 +3147,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 191
+            "line": 216
           },
           "name": "pathComponent",
           "type": {
@@ -3161,7 +3161,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 191
+            "line": 216
           },
           "name": "repositoryUrl",
           "type": {
@@ -3187,7 +3187,7 @@
         {
           "docs": {
             "stability": "experimental",
-            "summary": "Conect through SSH."
+            "summary": "Connect through SSH."
           },
           "name": "CONNECT_SSH"
         },
@@ -3210,7 +3210,7 @@
           "exampleMetadata": "infused",
           "resource": "AWS::Cloud9::EnvironmentEC2"
         },
-        "example": "// create a cloud9 ec2 environment in a new VPC\nconst vpc = new ec2.Vpc(this, 'VPC', { maxAzs: 3});\nnew cloud9.Ec2Environment(this, 'Cloud9Env', { vpc });\n\n// or create the cloud9 environment in the default VPC with specific instanceType\nconst defaultVpc = ec2.Vpc.fromLookup(this, 'DefaultVPC', { isDefault: true });\nnew cloud9.Ec2Environment(this, 'Cloud9Env2', {\n  vpc: defaultVpc,\n  instanceType: new ec2.InstanceType('t3.large'),\n});\n\n// or specify in a different subnetSelection\nconst c9env = new cloud9.Ec2Environment(this, 'Cloud9Env3', {\n  vpc,\n  subnetSelection: {\n    subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,\n  },\n});\n\n// print the Cloud9 IDE URL in the output\nnew CfnOutput(this, 'URL', { value: c9env.ideUrl });",
+        "example": "import * as codecommit from 'aws-cdk-lib/aws-codecommit';\n\n// create a codecommit repository to clone into the cloud9 environment\nconst repoNew = new codecommit.Repository(this, 'RepoNew', {\n  repositoryName: 'new-repo',\n});\n\n// import an existing codecommit repository to clone into the cloud9 environment\nconst repoExisting = codecommit.Repository.fromRepositoryName(this, 'RepoExisting', 'existing-repo');\n\n// create a new Cloud9 environment and clone the two repositories\ndeclare const vpc: ec2.Vpc;\nnew cloud9.Ec2Environment(this, 'C9Env', {\n  vpc,\n  clonedRepositories: [\n    cloud9.CloneRepository.fromCodeCommit(repoNew, '/src/new-repo'),\n    cloud9.CloneRepository.fromCodeCommit(repoExisting, '/src/existing-repo'),\n  ],\n  imageId: cloud9.ImageId.AMAZON_LINUX_2,\n});",
         "stability": "experimental",
         "summary": "A Cloud9 Environment with Amazon EC2."
       },
@@ -3221,7 +3221,7 @@
         },
         "locationInModule": {
           "filename": "lib/environment.ts",
-          "line": 147
+          "line": 167
         },
         "parameters": [
           {
@@ -3250,7 +3250,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "lib/environment.ts",
-        "line": 102
+        "line": 122
       },
       "methods": [
         {
@@ -3260,7 +3260,7 @@
           },
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 106
+            "line": 126
           },
           "name": "fromEc2EnvironmentName",
           "parameters": [
@@ -3304,7 +3304,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 130
+            "line": 150
           },
           "name": "ec2EnvironmentArn",
           "overrides": "@aws-cdk/aws-cloud9-alpha.IEc2Environment",
@@ -3323,7 +3323,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 123
+            "line": 143
           },
           "name": "ec2EnvironmentName",
           "overrides": "@aws-cdk/aws-cloud9-alpha.IEc2Environment",
@@ -3339,7 +3339,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 135
+            "line": 155
           },
           "name": "environmentId",
           "type": {
@@ -3354,7 +3354,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 140
+            "line": 160
           },
           "name": "ideUrl",
           "type": {
@@ -3369,7 +3369,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 145
+            "line": 165
           },
           "name": "vpc",
           "type": {
@@ -3386,7 +3386,7 @@
         "custom": {
           "exampleMetadata": "infused"
         },
-        "example": "// create a cloud9 ec2 environment in a new VPC\nconst vpc = new ec2.Vpc(this, 'VPC', { maxAzs: 3});\nnew cloud9.Ec2Environment(this, 'Cloud9Env', { vpc });\n\n// or create the cloud9 environment in the default VPC with specific instanceType\nconst defaultVpc = ec2.Vpc.fromLookup(this, 'DefaultVPC', { isDefault: true });\nnew cloud9.Ec2Environment(this, 'Cloud9Env2', {\n  vpc: defaultVpc,\n  instanceType: new ec2.InstanceType('t3.large'),\n});\n\n// or specify in a different subnetSelection\nconst c9env = new cloud9.Ec2Environment(this, 'Cloud9Env3', {\n  vpc,\n  subnetSelection: {\n    subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,\n  },\n});\n\n// print the Cloud9 IDE URL in the output\nnew CfnOutput(this, 'URL', { value: c9env.ideUrl });",
+        "example": "import * as codecommit from 'aws-cdk-lib/aws-codecommit';\n\n// create a codecommit repository to clone into the cloud9 environment\nconst repoNew = new codecommit.Repository(this, 'RepoNew', {\n  repositoryName: 'new-repo',\n});\n\n// import an existing codecommit repository to clone into the cloud9 environment\nconst repoExisting = codecommit.Repository.fromRepositoryName(this, 'RepoExisting', 'existing-repo');\n\n// create a new Cloud9 environment and clone the two repositories\ndeclare const vpc: ec2.Vpc;\nnew cloud9.Ec2Environment(this, 'C9Env', {\n  vpc,\n  clonedRepositories: [\n    cloud9.CloneRepository.fromCodeCommit(repoNew, '/src/new-repo'),\n    cloud9.CloneRepository.fromCodeCommit(repoExisting, '/src/existing-repo'),\n  ],\n  imageId: cloud9.ImageId.AMAZON_LINUX_2,\n});",
         "stability": "experimental",
         "summary": "Properties for Ec2Environment."
       },
@@ -3394,10 +3394,26 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "lib/environment.ts",
-        "line": 44
+        "line": 58
       },
       "name": "Ec2EnvironmentProps",
       "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The image ID used for creating an Amazon EC2 environment."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/environment.ts",
+            "line": 115
+          },
+          "name": "imageId",
+          "type": {
+            "fqn": "@aws-cdk/aws-cloud9-alpha.ImageId"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -3407,7 +3423,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 64
+            "line": 78
           },
           "name": "vpc",
           "type": {
@@ -3424,7 +3440,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 86
+            "line": 100
           },
           "name": "clonedRepositories",
           "optional": true,
@@ -3448,7 +3464,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 95
+            "line": 109
           },
           "name": "connectionType",
           "optional": true,
@@ -3466,7 +3482,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 78
+            "line": 92
           },
           "name": "description",
           "optional": true,
@@ -3484,7 +3500,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 71
+            "line": 85
           },
           "name": "ec2EnvironmentName",
           "optional": true,
@@ -3502,7 +3518,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 50
+            "line": 64
           },
           "name": "instanceType",
           "optional": true,
@@ -3520,7 +3536,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/environment.ts",
-            "line": 58
+            "line": 72
           },
           "name": "subnetSelection",
           "optional": true,
@@ -3588,8 +3604,43 @@
         }
       ],
       "symbolId": "lib/environment:IEc2Environment"
+    },
+    "@aws-cdk/aws-cloud9-alpha.ImageId": {
+      "assembly": "@aws-cdk/aws-cloud9-alpha",
+      "docs": {
+        "custom": {
+          "exampleMetadata": "infused"
+        },
+        "example": "import * as codecommit from 'aws-cdk-lib/aws-codecommit';\n\n// create a codecommit repository to clone into the cloud9 environment\nconst repoNew = new codecommit.Repository(this, 'RepoNew', {\n  repositoryName: 'new-repo',\n});\n\n// import an existing codecommit repository to clone into the cloud9 environment\nconst repoExisting = codecommit.Repository.fromRepositoryName(this, 'RepoExisting', 'existing-repo');\n\n// create a new Cloud9 environment and clone the two repositories\ndeclare const vpc: ec2.Vpc;\nnew cloud9.Ec2Environment(this, 'C9Env', {\n  vpc,\n  clonedRepositories: [\n    cloud9.CloneRepository.fromCodeCommit(repoNew, '/src/new-repo'),\n    cloud9.CloneRepository.fromCodeCommit(repoExisting, '/src/existing-repo'),\n  ],\n  imageId: cloud9.ImageId.AMAZON_LINUX_2,\n});",
+        "stability": "experimental",
+        "summary": "The image ID used for creating an Amazon EC2 environment."
+      },
+      "fqn": "@aws-cdk/aws-cloud9-alpha.ImageId",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "lib/environment.ts",
+        "line": 44
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Create using Amazon Linux 2."
+          },
+          "name": "AMAZON_LINUX_2"
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Create using Ubunut 18.04."
+          },
+          "name": "UBUNTU_18_04"
+        }
+      ],
+      "name": "ImageId",
+      "symbolId": "lib/environment:ImageId"
     }
   },
-  "version": "2.32.0-alpha.0",
+  "version": "2.34.0-alpha.0",
   "fingerprint": "**********"
 }