Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class CreateEnvironmentEC2CommandProtected

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

Example

Use a bare-bones client and the command you need to make an API call.

import { Cloud9Client, CreateEnvironmentEC2Command } from "@aws-sdk/client-cloud9"; // ES Modules import
// const { Cloud9Client, CreateEnvironmentEC2Command } = require("@aws-sdk/client-cloud9"); // CommonJS import
const client = new Cloud9Client(config);
const input = { // CreateEnvironmentEC2Request
name: "STRING_VALUE", // required
description: "STRING_VALUE",
clientRequestToken: "STRING_VALUE",
instanceType: "STRING_VALUE", // required
subnetId: "STRING_VALUE",
imageId: "STRING_VALUE",
automaticStopTimeMinutes: Number("int"),
ownerArn: "STRING_VALUE",
tags: [ // TagList
{ // Tag
Key: "STRING_VALUE", // required
Value: "STRING_VALUE", // required
},
],
connectionType: "CONNECT_SSH" || "CONNECT_SSM",
dryRun: true || false,
};
const command = new CreateEnvironmentEC2Command(input);
const response = await client.send(command);
// { // CreateEnvironmentEC2Result
// environmentId: "STRING_VALUE",
// };

Param

CreateEnvironmentEC2CommandInput

Returns

CreateEnvironmentEC2CommandOutput

See

Throws

BadRequestException (client fault)

The target request is invalid.

Throws

ConflictException (client fault)

A conflict occurred.

Throws

ForbiddenException (client fault)

An access permissions issue occurred.

Throws

InternalServerErrorException (server fault)

An internal server error occurred.

Throws

LimitExceededException (client fault)

A service limit was exceeded.

Throws

NotFoundException (client fault)

The target resource cannot be found.

Throws

TooManyRequestsException (client fault)

Too many service requests were made over the given time period.

Throws

Cloud9ServiceException

Base exception class for all service exceptions from Cloud9 service.

Example

CreateEnvironmentEC2

//
const input = {
"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"
};
const command = new CreateEnvironmentEC2Command(input);
const response = await client.send(command);
/* response ==
{
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
}
*/
// example id: createenvironmentec2-1516821730547

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods