CfnEnvironmentEC2Props

class aws_cdk.aws_cloud9.CfnEnvironmentEC2Props(*, instance_type, automatic_stop_time_minutes=None, connection_type=None, description=None, image_id=None, name=None, owner_arn=None, repositories=None, subnet_id=None, tags=None)

Bases: object

Properties for defining a CfnEnvironmentEC2.

Parameters
  • instance_type (str) – The type of instance to connect to the environment (for example, t2.micro ).

  • automatic_stop_time_minutes (Union[int, float, None]) – The number of minutes until the running instance is shut down after the environment was last used.

  • connection_type (Optional[str]) – The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through AWS Systems Manager ).

  • description (Optional[str]) – The description of the environment to create.

  • image_id (Optional[str]) – The identifier for the Amazon Machine Image (AMI) that’s used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager path. The default AMI is used if the parameter isn’t explicitly assigned a value in the request. AMI aliases - Amazon Linux (default): ``amazonlinux-1-x86_64`` - Amazon Linux 2: amazonlinux-2-x86_64 - Ubuntu 18.04: ubuntu-18.04-x86_64 SSM paths - Amazon Linux (default): ``resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64`` - Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64 - Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64

  • name (Optional[str]) – The name of the environment.

  • owner_arn (Optional[str]) – The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS Identity and Access Management principal. If this value is not specified, the ARN defaults to this environment’s creator.

  • repositories (Union[IResolvable, Sequence[Union[RepositoryProperty, IResolvable]], None]) – Any AWS CodeCommit source code repositories to be cloned into the development environment.

  • subnet_id (Optional[str]) – The ID of the subnet in Amazon Virtual Private Cloud (Amazon VPC) that AWS Cloud9 will use to communicate with the Amazon Elastic Compute Cloud (Amazon EC2) instance.

  • tags (Optional[Sequence[CfnTag]]) – An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cloud9 as cloud9

cfn_environment_eC2_props = cloud9.CfnEnvironmentEC2Props(
    instance_type="instanceType",

    # the properties below are optional
    automatic_stop_time_minutes=123,
    connection_type="connectionType",
    description="description",
    image_id="imageId",
    name="name",
    owner_arn="ownerArn",
    repositories=[cloud9.CfnEnvironmentEC2.RepositoryProperty(
        path_component="pathComponent",
        repository_url="repositoryUrl"
    )],
    subnet_id="subnetId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

automatic_stop_time_minutes

The number of minutes until the running instance is shut down after the environment was last used.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-automaticstoptimeminutes

Return type

Union[int, float, None]

connection_type

The connection type used for connecting to an Amazon EC2 environment.

Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through AWS Systems Manager ).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-connectiontype

Return type

Optional[str]

description

The description of the environment to create.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-description

Return type

Optional[str]

image_id

The identifier for the Amazon Machine Image (AMI) that’s used to create the EC2 instance.

To choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager path.

The default AMI is used if the parameter isn’t explicitly assigned a value in the request.

AMI aliases

  • Amazon Linux (default): ``amazonlinux-1-x86_64``

  • Amazon Linux 2: amazonlinux-2-x86_64

  • Ubuntu 18.04: ubuntu-18.04-x86_64

SSM paths

  • Amazon Linux (default): ``resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64``

  • Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64

  • Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-imageid

Return type

Optional[str]

instance_type

The type of instance to connect to the environment (for example, t2.micro ).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-instancetype

Return type

str

name

The name of the environment.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-name

Return type

Optional[str]

owner_arn

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

This ARN can be the ARN of any AWS Identity and Access Management principal. If this value is not specified, the ARN defaults to this environment’s creator.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-ownerarn

Return type

Optional[str]

repositories

Any AWS CodeCommit source code repositories to be cloned into the development environment.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-repositories

Return type

Union[IResolvable, List[Union[RepositoryProperty, IResolvable]], None]

subnet_id

The ID of the subnet in Amazon Virtual Private Cloud (Amazon VPC) that AWS Cloud9 will use to communicate with the Amazon Elastic Compute Cloud (Amazon EC2) instance.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-subnetid

Return type

Optional[str]

tags

An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-tags

Return type

Optional[List[CfnTag]]