Cloud9
This page documents function available when using the Cloud9 module, created with @service Cloud9.
Index
Main.Cloud9.create_environment_ec2Main.Cloud9.create_environment_membershipMain.Cloud9.delete_environmentMain.Cloud9.delete_environment_membershipMain.Cloud9.describe_environment_membershipsMain.Cloud9.describe_environment_statusMain.Cloud9.describe_environmentsMain.Cloud9.list_environmentsMain.Cloud9.list_tags_for_resourceMain.Cloud9.tag_resourceMain.Cloud9.untag_resourceMain.Cloud9.update_environmentMain.Cloud9.update_environment_membership
Documentation
Main.Cloud9.create_environment_ec2 — Methodcreate_environment_ec2(instance_type, name)
create_environment_ec2(instance_type, name, params::Dict{String,<:Any})Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.
Arguments
instance_type: The type of instance to connect to the environment (for example, t2.micro).name: The name of the environment to create. This name is visible to other AWS IAM users in the same AWS account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"automaticStopTimeMinutes": The number of minutes until the running instance is shut down after the environment has last been used."clientRequestToken": A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time. For more information, see Client Tokens in the Amazon EC2 API Reference."connectionType": The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECTSSH (default) and CONNECTSSM (connected through AWS Systems Manager). For more information, see Accessing no-ingress EC2 instances with AWS Systems Manager in the AWS Cloud9 User Guide."description": The description of the environment to create."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 AWS Systems Manager (SSM) path. The default AMI is used if the parameter isn't explicitly assigned a value in the request. AMI aliases Amazon Linux (default): amazonlinux-1-x8664 Amazon Linux 2: amazonlinux-2-x8664 Ubuntu 18.04: ubuntu-18.04-x8664 SSM paths Amazon Linux (default): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x8664 Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x8664 Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x8664"ownerArn": The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator."subnetId": The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance."tags": An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.
Main.Cloud9.create_environment_membership — Methodcreate_environment_membership(environment_id, permissions, user_arn)
create_environment_membership(environment_id, permissions, user_arn, params::Dict{String,<:Any})Adds an environment member to an AWS Cloud9 development environment.
Arguments
environment_id: The ID of the environment that contains the environment member you want to add.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.user_arn: The Amazon Resource Name (ARN) of the environment member you want to add.
Main.Cloud9.delete_environment — Methoddelete_environment(environment_id)
delete_environment(environment_id, params::Dict{String,<:Any})Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
Arguments
environment_id: The ID of the environment to delete.
Main.Cloud9.delete_environment_membership — Methoddelete_environment_membership(environment_id, user_arn)
delete_environment_membership(environment_id, user_arn, params::Dict{String,<:Any})Deletes an environment member from an AWS Cloud9 development environment.
Arguments
environment_id: The ID of the environment to delete the environment member from.user_arn: The Amazon Resource Name (ARN) of the environment member to delete from the environment.
Main.Cloud9.describe_environment_memberships — Methoddescribe_environment_memberships()
describe_environment_memberships(params::Dict{String,<:Any})Gets information about environment members for an AWS Cloud9 development environment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"environmentId": The ID of the environment to get environment member information about."maxResults": The maximum number of environment members to get information about."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."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."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.
Main.Cloud9.describe_environment_status — Methoddescribe_environment_status(environment_id)
describe_environment_status(environment_id, params::Dict{String,<:Any})Gets status information for an AWS Cloud9 development environment.
Arguments
environment_id: The ID of the environment to get status information about.
Main.Cloud9.describe_environments — Methoddescribe_environments(environment_ids)
describe_environments(environment_ids, params::Dict{String,<:Any})Gets information about AWS Cloud9 development environments.
Arguments
environment_ids: The IDs of individual environments to get information about.
Main.Cloud9.list_environments — Methodlist_environments()
list_environments(params::Dict{String,<:Any})Gets a list of AWS Cloud9 development environment identifiers.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of environments to get identifiers for."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.
Main.Cloud9.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Gets a list of the tags associated with an AWS Cloud9 development environment.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to get the tags for.
Main.Cloud9.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Adds tags to an AWS Cloud9 development environment. Tags that you add to an AWS Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to add tags to.tags: The list of tags to add to the given AWS Cloud9 development environment.
Main.Cloud9.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes tags from an AWS Cloud9 development environment.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to remove tags from.tag_keys: The tag names of the tags to remove from the given AWS Cloud9 development environment.
Main.Cloud9.update_environment — Methodupdate_environment(environment_id)
update_environment(environment_id, params::Dict{String,<:Any})Changes the settings of an existing AWS Cloud9 development environment.
Arguments
environment_id: The ID of the environment to change settings.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"description": Any new or replacement description for the environment."name": A replacement name for the environment.
Main.Cloud9.update_environment_membership — Methodupdate_environment_membership(environment_id, permissions, user_arn)
update_environment_membership(environment_id, permissions, user_arn, params::Dict{String,<:Any})Changes the settings of an existing environment member for an AWS Cloud9 development environment.
Arguments
environment_id: The ID of the environment for the environment member whose settings you want to change.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.user_arn: The Amazon Resource Name (ARN) of the environment member whose settings you want to change.