AWS Cloud9
API Reference (API Version 2017-09-23)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Environment

Information about an AWS Cloud9 development environment.

Contents

arn

The Amazon Resource Name (ARN) of the environment.

Type: String

Required: No

description

The description for the environment.

Type: String

Length Constraints: Maximum length of 200.

Required: No

id

The ID of the environment.

Type: String

Pattern: ^[a-zA-Z0-9]{8,32}$

Required: No

lifecycle

The state of the environment in its creation or deletion lifecycle.

Type: EnvironmentLifecycle object

Required: No

name

The name of the environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 60.

Required: No

ownerArn

The Amazon Resource Name (ARN) of the environment owner.

Type: String

Required: No

type

The type of environment. Valid values include the following:

  • ec2: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.

  • ssh: Your own server connects to the environment.

Type: String

Valid Values: ssh | ec2

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: