Skip to content

CreateDevEnvironmentRequest

Source code in docs_src/capo_codecatalyst/types/create_dev_environment_request.py
class CreateDevEnvironmentRequest(TypedDict, closed=True):
    space_name: "capo_codecatalyst.types.name_string.NameString"
    """<p>The name of the space.</p>"""
    project_name: "capo_codecatalyst.types.name_string.NameString"
    """<p>The name of the project in the space.</p>"""
    repositories: NotRequired[
        "capo_codecatalyst.types.repositories_input.RepositoriesInput"
    ]
    """<p>The source repository that contains the branch to clone into the Dev Environment. </p>"""
    client_token: NotRequired["capo_codecatalyst.types.client_token.ClientToken"]
    """<p>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.</p>"""
    alias: NotRequired["str"]
    """<p>The user-defined alias for a Dev Environment.</p>"""
    ides: NotRequired[
        "capo_codecatalyst.types.ide_configuration_list.IdeConfigurationList"
    ]
    """<p>Information about the integrated development environment (IDE) configured for a Dev Environment.</p> <note> <p>An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided. </p> </note>"""
    instance_type: "capo_codecatalyst.types.instance_type.InstanceType"
    """<p>The Amazon EC2 instace type to use for the Dev Environment. </p>"""
    inactivity_timeout_minutes: (
        "capo_codecatalyst.types.inactivity_timeout_minutes.InactivityTimeoutMinutes"
    )
    """<p>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.</p>"""
    persistent_storage: "capo_codecatalyst.types.persistent_storage_configuration.PersistentStorageConfiguration"
    """<p>Information about the amount of storage allocated to the Dev Environment. </p> <note> <p>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.</p> </note>"""
    vpc_connection_name: NotRequired["capo_codecatalyst.types.name_string.NameString"]
    """<p>The name of the connection that will be used to connect to Amazon VPC, if any.</p>"""

alias instance-attribute

alias: NotRequired[str]

The user-defined alias for a Dev Environment.

client_token instance-attribute

client_token: NotRequired[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.

ides instance-attribute

ides: NotRequired[IdeConfigurationList]

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.

inactivity_timeout_minutes instance-attribute

inactivity_timeout_minutes: 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.

instance_type instance-attribute

instance_type: InstanceType

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

persistent_storage instance-attribute

persistent_storage: PersistentStorageConfiguration

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.

project_name instance-attribute

project_name: NameString

The name of the project in the space.

repositories instance-attribute

repositories: NotRequired[RepositoriesInput]

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

space_name instance-attribute

space_name: NameString

The name of the space.

vpc_connection_name instance-attribute

vpc_connection_name: NotRequired[NameString]

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