Client

cloud9

R Documentation

AWS Cloud9¶

Description¶

Cloud9

Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.

For more information about Cloud9, see the Cloud9 User Guide.

Cloud9 supports these operations:

create_environment_ec2: Creates an Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.
create_environment_membership: Adds an environment member to an environment.
delete_environment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
delete_environment_membership: Deletes an environment member from an environment.
describe_environment_memberships: Gets information about environment members for an environment.
describe_environments: Gets information about environments.
describe_environment_status: Gets status information for an environment.
list_environments: Gets a list of environment identifiers.
list_tags_for_resource: Gets the tags for an environment.
tag_resource: Adds tags to an environment.
untag_resource: Removes tags from an environment.
update_environment: Changes the settings of an existing environment.
update_environment_membership: Changes the settings of an existing environment member for an environment.

Usage¶

cloud9(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- cloud9(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

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
create_environment_membership: Adds an environment member to an Cloud9 development environment
delete_environment: Deletes an Cloud9 development environment
delete_environment_membership: Deletes an environment member from a development environment
describe_environment_memberships: Gets information about environment members for an Cloud9 development environment
describe_environments: Gets information about Cloud9 development environments
describe_environment_status: Gets status information for an Cloud9 development environment
list_environments: Gets a list of Cloud9 development environment identifiers
list_tags_for_resource: Gets a list of the tags associated with an Cloud9 development environment
tag_resource: Adds tags to an Cloud9 development environment
untag_resource: Removes tags from an Cloud9 development environment
update_environment: Changes the settings of an existing Cloud9 development environment
update_environment_membership: Changes the settings of an existing environment member for an Cloud9 development environment

Examples¶

## Not run: 
svc <- cloud9()
# 
svc$create_environment_ec2(
  name = "my-demo-environment",
  automaticStopTimeMinutes = 60L,
  description = "This is my demonstration environment.",
  imageId = "amazonlinux-2023-x86_64",
  instanceType = "t2.micro",
  ownerArn = "arn:aws:iam::123456789012:user/MyDemoUser",
  subnetId = "subnet-6300cd1b"
)

## End(Not run)