AWS.Cloud9 — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.Cloud9

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.

For more information about Cloud9, see the Cloud9 User Guide.

Cloud9 supports these operations:

Sending a Request Using Cloud9

var cloud9 = new AWS.Cloud9();
cloud9.createEnvironmentEC2(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Cloud9 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var cloud9 = new AWS.Cloud9({apiVersion: '2017-09-23'});

You can also set the API version globally in AWS.config.apiVersions using the cloud9 service identifier:

AWS.config.apiVersions = {
  cloud9: '2017-09-23',
  // other service API versions
};

var cloud9 = new AWS.Cloud9();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Cloud9(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createEnvironmentEC2(params = {}, callback) ⇒ AWS.Request

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

createEnvironmentMembership(params = {}, callback) ⇒ AWS.Request

Adds an environment member to an Cloud9 development environment.

deleteEnvironment(params = {}, callback) ⇒ AWS.Request

Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.

deleteEnvironmentMembership(params = {}, callback) ⇒ AWS.Request

Deletes an environment member from a development environment.

describeEnvironmentMemberships(params = {}, callback) ⇒ AWS.Request

Gets information about environment members for an Cloud9 development environment.

describeEnvironments(params = {}, callback) ⇒ AWS.Request

Gets information about Cloud9 development environments.

describeEnvironmentStatus(params = {}, callback) ⇒ AWS.Request

Gets status information for an Cloud9 development environment.

listEnvironments(params = {}, callback) ⇒ AWS.Request

Gets a list of Cloud9 development environment identifiers.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Gets a list of the tags associated with an Cloud9 development environment.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds tags to an Cloud9 development environment.

Tags that you add to an Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from an Cloud9 development environment.

updateEnvironment(params = {}, callback) ⇒ AWS.Request

Changes the settings of an existing Cloud9 development environment.

updateEnvironmentMembership(params = {}, callback) ⇒ AWS.Request

Changes the settings of an existing environment member for an Cloud9 development environment.