environments

Creates, updates, deletes, gets or lists an environments resource.

Overview

Name	environments
Type	Resource
Id	aws.cloud9.environments

Fields

The following fields are returned by SELECT queries:

describe_environments

Name	Datatype	Description
environments	array	Information about the environments that are returned.

list_environments

Name	Datatype	Description
environment_id	string	The list of environment identifiers.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_environments	select	region		Gets information about Cloud9 development environments. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"
list_environments	select	region		Gets a list of Cloud9 development environment identifiers. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more" Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"
create_environment_ec2	insert	region, name, instanceType, imageId		Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"
update_environment	update	region, environmentId		Changes the settings of an existing Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"
delete_environment	delete	region		Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_environments

Gets information about Cloud9 development environments. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

SELECT
environments
FROM aws.cloud9.environments
WHERE region = '{{ region }}' -- required
;

list_environments

Gets a list of Cloud9 development environment identifiers. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more" Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

SELECT
environment_id
FROM aws.cloud9.environments
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_environment_ec2

Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

INSERT INTO aws.cloud9.environments (
name,
description,
clientRequestToken,
instanceType,
subnetId,
imageId,
automaticStopTimeMinutes,
ownerArn,
tags,
connectionType,
dryRun,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ clientRequestToken }}',
'{{ instanceType }}' /* required */,
'{{ subnetId }}',
'{{ imageId }}' /* required */,
{{ automaticStopTimeMinutes }},
'{{ ownerArn }}',
'{{ tags }}',
'{{ connectionType }}',
{{ dryRun }},
'{{ region }}'
RETURNING
environment_id
;

Manifest

# Description fields are for documentation purposes
- name: environments
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the environments resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the environment to create. This name is visible to other IAM users in the same Amazon Web Services account.
  - name: description
    value: "{{ description }}"
    description: |
      The description of the environment to create.
  - name: clientRequestToken
    value: "{{ clientRequestToken }}"
    description: |
      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.
  - name: instanceType
    value: "{{ instanceType }}"
    description: |
      The type of instance to connect to the environment (for example, t2.micro).
  - name: subnetId
    value: "{{ subnetId }}"
    description: |
      The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
  - name: imageId
    value: "{{ imageId }}"
    description: |
      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. We recommend using Amazon Linux 2023 as the AMI to create your environment as it is fully supported. From December 16, 2024, Ubuntu 18.04 will be removed from the list of available imageIds for Cloud9. This change is necessary as Ubuntu 18.04 has ended standard support on May 31, 2023. This change will only affect direct API consumers, and not Cloud9 console users. Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04. AMI aliases Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64 Ubuntu 22.04: ubuntu-22.04-x86_64 SSM paths Amazon Linux 2023 (recommended): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64 Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64
  - name: automaticStopTimeMinutes
    value: {{ automaticStopTimeMinutes }}
    description: |
      The number of minutes until the running instance is shut down after the environment has last been used.
  - name: ownerArn
    value: "{{ ownerArn }}"
    description: |
      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.
  - name: tags
    description: |
      An array of key-value pairs that will be associated with the new Cloud9 development environment.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: connectionType
    value: "{{ connectionType }}"
    description: |
      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.
    valid_values: ['CONNECT_SSH', 'CONNECT_SSM']
  - name: dryRun
    value: {{ dryRun }}
    description: |
      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.

UPDATE examples

update_environment

Changes the settings of an existing Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

UPDATE aws.cloud9.environments
SET 
environmentId = '{{ environmentId }}',
name = '{{ name }}',
description = '{{ description }}',
managedCredentialsAction = '{{ managedCredentialsAction }}'
WHERE 
region = '{{ region }}' --required
AND environmentId = '{{ environmentId }}' --required;

DELETE examples

delete_environment

Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

DELETE FROM aws.cloud9.environments
WHERE region = '{{ region }}' --required
;