Cloud9 / Client / create_environment_ec2

create_environment_ec2#

Cloud9.Client.create_environment_ec2(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_environment_ec2(
    name='string',
    description='string',
    clientRequestToken='string',
    instanceType='string',
    subnetId='string',
    imageId='string',
    automaticStopTimeMinutes=123,
    ownerArn='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    connectionType='CONNECT_SSH'|'CONNECT_SSM',
    dryRun=True|False
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of the environment to create.

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

  • description (string) – The description of the environment to create.

  • clientRequestToken (string) –

    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 (string) –

    [REQUIRED]

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

  • subnetId (string) – The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.

  • imageId (string) –

    [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 CreateEnvironmentEC2 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.

    From January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2 as the AMI to create your environment as it is fully supported. This change will only affect direct API consumers, and not Cloud9 console users.

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

    AMI aliases

    • Amazon Linux: amazonlinux-1-x86_64

    • Amazon Linux 2: amazonlinux-2-x86_64

    • Ubuntu 18.04: ubuntu-18.04-x86_64

    • Ubuntu 22.04: ubuntu-22.04-x86_64

    SSM paths

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

    • Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-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 (integer) – The number of minutes until the running instance is shut down after the environment has last been used.

  • ownerArn (string) – 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 (list) –

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

    • (dict) –

      Metadata that is associated with Amazon Web Services resources. In particular, a name-value pair that can be associated with an Cloud9 development environment. There are two types of tags: user tags and system tags. A user tag is created by the user. A system tag is automatically created by Amazon Web Services services. A system tag is prefixed with "aws:" and cannot be modified by the user.

      • Key (string) – [REQUIRED]

        The name part of a tag.

      • Value (string) – [REQUIRED]

        The value part of a tag.

  • connectionType (string) –

    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 (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'environmentId': 'string'
}

Response Structure

  • (dict) –

    • environmentId (string) –

      The ID of the environment that was created.

Exceptions

  • Cloud9.Client.exceptions.BadRequestException

  • Cloud9.Client.exceptions.ConflictException

  • Cloud9.Client.exceptions.NotFoundException

  • Cloud9.Client.exceptions.ForbiddenException

  • Cloud9.Client.exceptions.TooManyRequestsException

  • Cloud9.Client.exceptions.LimitExceededException

  • Cloud9.Client.exceptions.InternalServerErrorException

Examples

response = client.create_environment_ec2(
    name='my-demo-environment',
    automaticStopTimeMinutes=60,
    description='This is my demonstration environment.',
    instanceType='t2.micro',
    ownerArn='arn:aws:iam::123456789012:user/MyDemoUser',
    subnetId='subnet-6300cd1b',
)

print(response)

Expected Output:

{
    'environmentId': '8d9967e2f0624182b74e7690ad69ebEX',
    'ResponseMetadata': {
        '...': '...',
    },
}