Environment
Information about an AWS Cloud9 development environment.
Contents
- arn
-
The Amazon Resource Name (ARN) of the environment.
Type: String
Required: Yes
- ownerArn
-
The Amazon Resource Name (ARN) of the environment owner.
Type: String
Required: Yes
- 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 | ec2Required: Yes
-
- connectionType
-
The connection type used for connecting to an Amazon EC2 environment.
CONNECT_SSHis selected by default.Type: String
Valid Values:
CONNECT_SSH | CONNECT_SSMRequired: 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
- managedCredentialsStatus
-
Describes the status of AWS managed temporary credentials for the AWS Cloud9 environment. Available values are:
-
ENABLED_ON_CREATE -
ENABLED_BY_OWNER -
DISABLED_BY_DEFAULT -
DISABLED_BY_OWNER -
DISABLED_BY_COLLABORATOR -
PENDING_REMOVAL_BY_COLLABORATOR -
PENDING_REMOVAL_BY_OWNER -
FAILED_REMOVAL_BY_COLLABORATOR -
ENABLED_BY_OWNER -
DISABLED_BY_DEFAULT
Type: String
Valid Values:
ENABLED_ON_CREATE | ENABLED_BY_OWNER | DISABLED_BY_DEFAULT | DISABLED_BY_OWNER | DISABLED_BY_COLLABORATOR | PENDING_REMOVAL_BY_COLLABORATOR | PENDING_START_REMOVAL_BY_COLLABORATOR | PENDING_REMOVAL_BY_OWNER | PENDING_START_REMOVAL_BY_OWNER | FAILED_REMOVAL_BY_COLLABORATOR | FAILED_REMOVAL_BY_OWNERRequired: No
-
- name
-
The name of the environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 60.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
