Skip to content

Update Dev Environment

codecatalyst_update_dev_environment R Documentation

Changes one or more values for a Dev Environment

Description

Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.

Usage

codecatalyst_update_dev_environment(spaceName, projectName, id, alias,
  ides, instanceType, inactivityTimeoutMinutes, clientToken)

Arguments

spaceName

[required] The name of the space.

projectName

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

id

[required] The system-generated unique ID of the Dev Environment.

alias

The user-specified alias for the Dev Environment. Changing this value will not cause a restart.

ides

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

instanceType

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

Changing this value will cause a restart of the Dev Environment if it is running.

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.

Changing this value will cause a restart of the Dev Environment if it is running.

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.

Value

A list with the following syntax: 

list(
  id = "string",
  spaceName = "string",
  projectName = "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,
  clientToken = "string"
)

Request syntax

svc$update_dev_environment(
  spaceName = "string",
  projectName = "string",
  id = "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,
  clientToken = "string"
)