Skip to content

Create Dev Environment

codecatalyst_create_dev_environment R Documentation

Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project

Description

Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.

When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these defaults apply to a Dev Environment created programmatically.

Usage

codecatalyst_create_dev_environment(spaceName, projectName,
  repositories, clientToken, alias, ides, instanceType,
  inactivityTimeoutMinutes, persistentStorage, vpcConnectionName)

Arguments

spaceName

[required] The name of the space.

projectName

[required] The name of the project in the space.

repositories

The source repository that contains the branch to clone into the Dev Environment.

clientToken

A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

alias

The user-defined alias for a Dev Environment.

ides

Information about the integrated development environment (IDE) configured for a Dev Environment.

An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided.

instanceType

[required] The Amazon EC2 instace type to use for the Dev Environment.

inactivityTimeoutMinutes

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

persistentStorage

[required] Information about the amount of storage allocated to the Dev Environment.

By default, a Dev Environment is configured to have 16GB of persistent storage when created from the Amazon CodeCatalyst console, but there is no default when programmatically creating a Dev Environment. Valid values for persistent storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

vpcConnectionName

The name of the connection that will be used to connect to Amazon VPC, if any.

Value

A list with the following syntax: 

list(
  spaceName = "string",
  projectName = "string",
  id = "string",
  vpcConnectionName = "string"
)

Request syntax

svc$create_dev_environment(
  spaceName = "string",
  projectName = "string",
  repositories = list(
    list(
      repositoryName = "string",
      branchName = "string"
    )
  ),
  clientToken = "string",
  alias = "string",
  ides = list(
    list(
      runtime = "string",
      name = "string"
    )
  ),
  instanceType = "dev.standard1.small"|"dev.standard1.medium"|"dev.standard1.large"|"dev.standard1.xlarge",
  inactivityTimeoutMinutes = 123,
  persistentStorage = list(
    sizeInGiB = 123
  ),
  vpcConnectionName = "string"
)