Skip to content

Environment

Source code in docs_src/capo_cloud9/types/environment.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class Environment(TypedDict, closed=True):
    id: NotRequired["capo_cloud9.types.environment_id.EnvironmentId"]
    """<p>The ID of the environment.</p>"""
    name: NotRequired["capo_cloud9.types.environment_name.EnvironmentName"]
    """<p>The name of the environment.</p>"""
    description: NotRequired[
        "capo_cloud9.types.environment_description.EnvironmentDescription"
    ]
    """<p>The description for the environment.</p>"""
    type: "capo_cloud9.types.environment_type.EnvironmentType"
    """<p>The type of environment. Valid values include the following:</p> <ul> <li> <p> <code>ec2</code>: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.</p> </li> <li> <p> <code>ssh</code>: Your own server connects to the environment.</p> </li> </ul>"""
    connection_type: NotRequired["capo_cloud9.types.connection_type.ConnectionType"]
    """<p>The connection type used for connecting to an Amazon EC2 environment. <code>CONNECT_SSH</code> is selected by default.</p>"""
    arn: "capo_cloud9.types.string.String"
    """<p>The Amazon Resource Name (ARN) of the environment.</p>"""
    owner_arn: "capo_cloud9.types.string.String"
    """<p>The Amazon Resource Name (ARN) of the environment owner.</p>"""
    lifecycle: NotRequired[
        "capo_cloud9.types.environment_lifecycle.EnvironmentLifecycle"
    ]
    """<p>The state of the environment in its creation or deletion lifecycle.</p>"""
    managed_credentials_status: NotRequired[
        "capo_cloud9.types.managed_credentials_status.ManagedCredentialsStatus"
    ]
    """<p>Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are:</p> <ul> <li> <p> <code>ENABLED_ON_CREATE</code> </p> </li> <li> <p> <code>ENABLED_BY_OWNER</code> </p> </li> <li> <p> <code>DISABLED_BY_DEFAULT</code> </p> </li> <li> <p> <code>DISABLED_BY_OWNER</code> </p> </li> <li> <p> <code>DISABLED_BY_COLLABORATOR</code> </p> </li> <li> <p> <code>PENDING_REMOVAL_BY_COLLABORATOR</code> </p> </li> <li> <p> <code>PENDING_REMOVAL_BY_OWNER</code> </p> </li> <li> <p> <code>FAILED_REMOVAL_BY_COLLABORATOR</code> </p> </li> <li> <p> <code>ENABLED_BY_OWNER</code> </p> </li> <li> <p> <code>DISABLED_BY_DEFAULT</code> </p> </li> </ul>"""

arn instance-attribute 

arn: String

The Amazon Resource Name (ARN) of the environment.

connection_type instance-attribute 

connection_type: NotRequired[ConnectionType]

The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH is selected by default.

description instance-attribute 

description: NotRequired[EnvironmentDescription]

The description for the environment.

id instance-attribute 

id: NotRequired[EnvironmentId]

The ID of the environment.

lifecycle instance-attribute 

lifecycle: NotRequired[EnvironmentLifecycle]

The state of the environment in its creation or deletion lifecycle.

managed_credentials_status instance-attribute 

managed_credentials_status: NotRequired[ManagedCredentialsStatus]

Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are:

  • ENABLED_ON_CREATE

  • ENABLED_BY_OWNER

  • DISABLED_BY_DEFAULT

  • DISABLED_BY_OWNER

  • DISABLED_BY_COLLABORATOR

  • PENDING_REMOVAL_BY_COLLABORATOR

  • PENDING_REMOVAL_BY_OWNER

  • FAILED_REMOVAL_BY_COLLABORATOR

  • ENABLED_BY_OWNER

  • DISABLED_BY_DEFAULT

name instance-attribute 

name: NotRequired[EnvironmentName]

The name of the environment.

owner_arn instance-attribute 

owner_arn: String

The Amazon Resource Name (ARN) of the environment owner.

type instance-attribute 

type: EnvironmentType

The type of environment. Valid values include the following:

  • ec2: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.

  • ssh: Your own server connects to the environment.