Skip to content

Create Environment Ec2

cloud9_create_environment_ec2 R Documentation

Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment

Description

Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.

Usage

cloud9_create_environment_ec2(name, description, clientRequestToken,
  instanceType, subnetId, imageId, automaticStopTimeMinutes, ownerArn,
  tags, connectionType, dryRun)

Arguments

name

[required] The name of the environment to create.

This name is visible to other IAM users in the same Amazon Web Services account.

description

The description of the environment to create.

clientRequestToken

A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.

For more information, see Client Tokens in the Amazon EC2 API Reference.

instanceType

[required] The type of instance to connect to the environment (for example, t2.micro).

subnetId

The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.

imageId

[required] The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM) path.

From December 04, 2023, you will be required to include the imageId parameter for the create_environment_ec2 action. This change will be reflected across all direct methods of communicating with the API, such as Amazon Web Services SDK, Amazon Web Services CLI and Amazon Web Services CloudFormation. This change will only affect direct API consumers, and not Cloud9 console users.

We recommend using Amazon Linux 2023 as the AMI to create your environment as it is fully supported.

Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.

AMI aliases

  • Amazon Linux 2: amazonlinux-2-x86_64

  • Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64

  • Ubuntu 18.04: ubuntu-18.04-x86_64

  • Ubuntu 22.04: ubuntu-22.04-x86_64

SSM paths

  • Amazon Linux 2: ⁠resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64⁠

  • Amazon Linux 2023 (recommended): ⁠resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64⁠

  • Ubuntu 18.04: ⁠resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64⁠

  • Ubuntu 22.04: ⁠resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64⁠

automaticStopTimeMinutes

The number of minutes until the running instance is shut down after the environment has last been used.

ownerArn

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

tags

An array of key-value pairs that will be associated with the new Cloud9 development environment.

connectionType

The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon EC2 Systems Manager).

For more information, see Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager in the Cloud9 User Guide.

dryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Value

A list with the following syntax: 

list(
  environmentId = "string"
)

Request syntax

svc$create_environment_ec2(
  name = "string",
  description = "string",
  clientRequestToken = "string",
  instanceType = "string",
  subnetId = "string",
  imageId = "string",
  automaticStopTimeMinutes = 123,
  ownerArn = "string",
  tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  connectionType = "CONNECT_SSH"|"CONNECT_SSM",
  dryRun = TRUE|FALSE
)

Examples

## Not run: 
# 
svc$create_environment_ec2(
  name = "my-demo-environment",
  automaticStopTimeMinutes = 60L,
  description = "This is my demonstration environment.",
  imageId = "amazonlinux-2023-x86_64",
  instanceType = "t2.micro",
  ownerArn = "arn:aws:iam::123456789012:user/MyDemoUser",
  subnetId = "subnet-6300cd1b"
)

## End(Not run)