Ec2Environment

class aws_cdk.aws_cloud9.Ec2Environment(scope, id, *, vpc, cloned_repositories=None, description=None, ec2_environment_name=None, instance_type=None, subnet_selection=None)

Bases: aws_cdk.core.Resource

(experimental) A Cloud9 Environment with Amazon EC2.

Stability

experimental

ExampleMetadata

infused

Resource

AWS::Cloud9::EnvironmentEC2

Example:

# Example automatically generated from non-compiling source. May contain errors.
from aws_cdk.aws_ec2 import SubnetSelection
import aws_cdk.aws_cloud9 as cloud9

# create a cloud9 ec2 environment in a new VPC
vpc = ec2.Vpc(self, "VPC", max_azs=3)
cloud9.Ec2Environment(self, "Cloud9Env", vpc=vpc)

# or create the cloud9 environment in the default VPC with specific instanceType
default_vpc = ec2.Vpc.from_lookup(self, "DefaultVPC", is_default=True)
cloud9.Ec2Environment(self, "Cloud9Env2",
    vpc=default_vpc,
    instance_type=ec2.InstanceType("t3.large")
)

# or specify in a different subnetSelection
c9env = cloud9.Ec2Environment(self, "Cloud9Env3",
    vpc=vpc,
    subnet_selection=SubnetSelection(
        subnet_type=ec2.SubnetType.PRIVATE
    )
)

# print the Cloud9 IDE URL in the output
cdk.CfnOutput(self, "URL", value=c9env.ide_url)
Parameters

  • scope (Construct) –

  • id (str) –

  • vpc (IVpc) – (experimental) The VPC that AWS Cloud9 will use to communicate with the Amazon Elastic Compute Cloud (Amazon EC2) instance.

  • cloned_repositories (Optional[Sequence[CloneRepository]]) – (experimental) The AWS CodeCommit repository to be cloned. Default: - do not clone any repository

  • description (Optional[str]) – (experimental) Description of the environment. Default: - no description

  • ec2_environment_name (Optional[str]) – (experimental) Name of the environment. Default: - automatically generated name

  • instance_type (Optional[InstanceType]) – (experimental) The type of instance to connect to the environment. Default: - t2.micro

  • subnet_selection (Optional[SubnetSelection]) – (experimental) The subnetSelection of the VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance. Default: - all public subnets of the VPC are selected.

Stability

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

ec2_environment_arn

(experimental) The environment ARN of this Cloud9 environment.

Stability

experimental

Attribute

true

Return type

str

ec2_environment_name

(experimental) The environment name of this Cloud9 environment.

Stability

experimental

Attribute

true

Return type

str

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

environment_id

(experimental) The environment ID of this Cloud9 environment.

Stability

experimental

Return type

str

ide_url

(experimental) The complete IDE URL of this Cloud9 environment.

Stability

experimental

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

vpc

(experimental) VPC ID.

Stability

experimental

Return type

IVpc

Static Methods

classmethod from_ec2_environment_name(scope, id, ec2_environment_name)

(experimental) import from EnvironmentEc2Name.

Parameters

  • scope (Construct) –

  • id (str) –

  • ec2_environment_name (str) –

Stability

experimental

Return type

IEc2Environment

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool