2.173.2

class Ec2Environment (construct) 🔹

LanguageType name
.NETAmazon.CDK.AWS.Cloud9.Alpha.Ec2Environment
Gogithub.com/aws/aws-cdk-go/awscdkcloud9alpha/v2#Ec2Environment
Javasoftware.amazon.awscdk.services.cloud9.alpha.Ec2Environment
Pythonaws_cdk.aws_cloud9_alpha.Ec2Environment
TypeScript (source)@aws-cdk/aws-cloud9-alpha » Ec2Environment

Implements IConstruct, IDependable, IResource, IEc2Environment

A Cloud9 Environment with Amazon EC2.

Example

import * as iam from 'aws-cdk-lib/aws-iam';

const user = new iam.User(this, 'user');
user.addManagedPolicy(iam.ManagedPolicy.fromAwsManagedPolicyName('AWSCloud9Administrator'));
declare const vpc: ec2.Vpc;
new cloud9.Ec2Environment(this, 'C9Env', {
  vpc,
  imageId: cloud9.ImageId.AMAZON_LINUX_2,

  owner: cloud9.Owner.user(user)
})

Initializer

new Ec2Environment(scope: Construct, id: string, props: Ec2EnvironmentProps)

Parameters

Construct Props

NameTypeDescription
imageId🔹ImageIdThe image ID used for creating an Amazon EC2 environment.
vpc🔹IVpcThe VPC that AWS Cloud9 will use to communicate with the Amazon Elastic Compute Cloud (Amazon EC2) instance.
automaticStop?🔹DurationThe number of minutes until the running instance is shut down after the environment was last used.
clonedRepositories?🔹CloneRepository[]The AWS CodeCommit repository to be cloned.
connectionType?🔹ConnectionTypeThe connection type used for connecting to an Amazon EC2 environment.
description?🔹stringDescription of the environment.
ec2EnvironmentName?🔹stringName of the environment.
instanceType?🔹InstanceTypeThe type of instance to connect to the environment.
owner?🔹OwnerOwner of the environment.
subnetSelection?🔹SubnetSelectionThe subnetSelection of the VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.

imageId🔹

Type: ImageId

The image ID used for creating an Amazon EC2 environment.

vpc🔹

Type: IVpc

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

automaticStop?🔹

Type: Duration (optional, default: The instance will not be shut down automatically.)

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

Setting a value of 0 means the instance will never be automatically shut down."

clonedRepositories?🔹

Type: CloneRepository[] (optional, default: do not clone any repository)

The AWS CodeCommit repository to be cloned.

connectionType?🔹

Type: ConnectionType (optional, default: CONNECT_SSH)

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?🔹

Type: string (optional, default: no description)

Description of the environment.

ec2EnvironmentName?🔹

Type: string (optional, default: automatically generated name)

Name of the environment.

instanceType?🔹

Type: InstanceType (optional, default: t2.micro)

The type of instance to connect to the environment.

owner?🔹

Type: Owner (optional, default: The identity that CloudFormation executes under will be the owner)

Owner of the environment.

The owner has full control of the environment and can invite additional members.

subnetSelection?🔹

Type: SubnetSelection (optional, default: all public subnets of the VPC are selected.)

The subnetSelection of the VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.

Properties

NameTypeDescription
ec2EnvironmentArn🔹stringThe environment ARN of this Cloud9 environment.
ec2EnvironmentName🔹stringThe environment name of this Cloud9 environment.
env🔹ResourceEnvironmentThe environment this resource belongs to.
environmentId🔹stringThe environment ID of this Cloud9 environment.
ideUrl🔹stringThe complete IDE URL of this Cloud9 environment.
node🔹NodeThe tree node.
stack🔹StackThe stack in which this resource is defined.
vpc🔹IVpcVPC ID.

ec2EnvironmentArn🔹

Type: string

The environment ARN of this Cloud9 environment.

ec2EnvironmentName🔹

Type: string

The environment name of this Cloud9 environment.

env🔹

Type: ResourceEnvironment

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.

environmentId🔹

Type: string

The environment ID of this Cloud9 environment.

ideUrl🔹

Type: string

The complete IDE URL of this Cloud9 environment.

node🔹

Type: Node

The tree node.

stack🔹

Type: Stack

The stack in which this resource is defined.

vpc🔹

Type: IVpc

VPC ID.

Methods

NameDescription
applyRemovalPolicy(policy)🔹Apply the given removal policy to this resource.
toString()🔹Returns a string representation of this construct.
static fromEc2EnvironmentName(scope, id, ec2EnvironmentName)🔹import from EnvironmentEc2Name.

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

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).

toString()🔹

public toString(): string

Returns

  • string

Returns a string representation of this construct.

static fromEc2EnvironmentName(scope, id, ec2EnvironmentName)🔹

public static fromEc2EnvironmentName(scope: Construct, id: string, ec2EnvironmentName: string): IEc2Environment

Parameters

  • scope Construct
  • id string
  • ec2EnvironmentName string

Returns

import from EnvironmentEc2Name.

← PreviousNext →