String name
The name of the environment to create.
This name is visible to other IAM users in the same Amazon Web Services account.
String description
The description of the environment to create.
String clientRequestToken
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.
String instanceType
The type of instance to connect to the environment (for example, t2.micro).
String subnetId
The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
String imageId
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.
The default AMI is used if the parameter isn't explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.
AMI aliases
Amazon Linux (default): amazonlinux-1-x86_64
Amazon Linux 2: amazonlinux-2-x86_64
Ubuntu 18.04: ubuntu-18.04-x86_64
SSM paths
Amazon Linux (default): 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
Integer automaticStopTimeMinutes
The number of minutes until the running instance is shut down after the environment has last been used.
String ownerArn
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.
List<E> tags
An array of key-value pairs that will be associated with the new Cloud9 development environment.
String connectionType
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.
Boolean dryRun
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.
String environmentId
The ID of the environment that was created.
String environmentId
The ID of the environment that contains the environment member you want to add.
String userArn
The Amazon Resource Name (ARN) of the environment member you want to add.
String permissions
The type of environment member permissions you want to associate with this environment member. Available values include:
read-only: Has read-only access to the environment.
read-write: Has read-write access to the environment.
EnvironmentMember membership
Information about the environment member that was added.
String environmentId
The ID of the environment to delete.
String userArn
The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.
String environmentId
The ID of the environment to get environment member information about.
List<E> permissions
The type of environment member permissions to get information about. Available values include:
owner: Owns the environment.
read-only: Has read-only access to the environment.
read-write: Has read-write access to the environment.
If no value is specified, information about all environment members are returned.
String nextToken
During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
Integer maxResults
The maximum number of environment members to get information about.
List<E> memberships
Information about the environment members for the environment.
String nextToken
If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.
String environmentId
The ID of the environment to get status information about.
String status
The status of the environment. Available values include:
connecting: The environment is connecting.
creating: The environment is being created.
deleting: The environment is being deleted.
error: The environment is in an error state.
ready: The environment is ready.
stopped: The environment is stopped.
stopping: The environment is stopping.
String message
Any informational message about the status of the environment.
String id
The ID of the environment.
String name
The name of the environment.
String description
The description for the environment.
String 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.
String connectionType
The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH is selected by
default.
String arn
The Amazon Resource Name (ARN) of the environment.
String ownerArn
The Amazon Resource Name (ARN) of the environment owner.
EnvironmentLifecycle lifecycle
The state of the environment in its creation or deletion lifecycle.
String managedCredentialsStatus
Describes the status of Amazon Web Services managed temporary credentials for the 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
String status
The current creation or deletion lifecycle state of the environment.
CREATING: The environment is in the process of being created.
CREATED: The environment was successfully created.
CREATE_FAILED: The environment failed to be created.
DELETING: The environment is in the process of being deleted.
DELETE_FAILED: The environment failed to delete.
String reason
Any informational message about the lifecycle state of the environment.
String failureResource
If the environment failed to delete, the Amazon Resource Name (ARN) of the related Amazon Web Services resource.
String permissions
The type of environment member permissions associated with this environment member. Available values include:
owner: Owns the environment.
read-only: Has read-only access to the environment.
read-write: Has read-write access to the environment.
String userId
The user ID in Identity and Access Management (IAM) of the environment member.
String userArn
The Amazon Resource Name (ARN) of the environment member.
String environmentId
The ID of the environment for the environment member.
Date lastAccess
The time, expressed in epoch time format, when the environment member last opened the environment.
String nextToken
During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
Integer maxResults
The maximum number of environments to get identifiers for.
String nextToken
If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.
List<E> environmentIds
The list of environment identifiers.
String resourceARN
The Amazon Resource Name (ARN) of the Cloud9 development environment to get the tags for.
String environmentId
The ID of the environment for the environment member whose settings you want to change.
String userArn
The Amazon Resource Name (ARN) of the environment member whose settings you want to change.
String permissions
The replacement type of environment member permissions you want to associate with this environment member. Available values include:
read-only: Has read-only access to the environment.
read-write: Has read-write access to the environment.
EnvironmentMember membership
Information about the environment member whose settings were changed.
String environmentId
The ID of the environment to change settings.
String name
A replacement name for the environment.
String description
Any new or replacement description for the environment.
String managedCredentialsAction
Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary credentials for an Cloud9 environment by using one of the following values:
ENABLE
DISABLE
Only the environment owner can change the status of managed temporary credentials. An
AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary credentials
is made by an account that's not the environment owner.
Copyright © 2022. All rights reserved.