Package software.amazon.awscdk.cfnpropertymixins.services.cloud9

Interface CfnEnvironmentEC2MixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentEC2MixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.929Z")
@Stability(Stable)
public interface CfnEnvironmentEC2MixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnEnvironmentEC2PropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cloud9.*;
 CfnEnvironmentEC2MixinProps cfnEnvironmentEC2MixinProps = CfnEnvironmentEC2MixinProps.builder()
         .automaticStopTimeMinutes(123)
         .connectionType("connectionType")
         .description("description")
         .imageId("imageId")
         .instanceType("instanceType")
         .name("name")
         .ownerArn("ownerArn")
         .repositories(List.of(RepositoryProperty.builder()
                 .pathComponent("pathComponent")
                 .repositoryUrl("repositoryUrl")
                 .build()))
         .subnetId("subnetId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEnvironmentEC2MixinProps.Builder	A builder for CfnEnvironmentEC2MixinProps
static final class	CfnEnvironmentEC2MixinProps.Jsii$Proxy	An implementation for CfnEnvironmentEC2MixinProps

Method Summary

Modifier and Type	Method	Description
static CfnEnvironmentEC2MixinProps.Builder	builder()
default Number	getAutomaticStopTimeMinutes()	The number of minutes until the running instance is shut down after the environment was last used.
default String	getConnectionType()	The connection type used for connecting to an Amazon EC2 environment.
default String	getDescription()	The description of the environment to create.
default String	getImageId()	The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
default String	getInstanceType()	The type of instance to connect to the environment (for example, t2.micro ).
default String	getName()	The name of the environment.
default String	getOwnerArn()	The Amazon Resource Name (ARN) of the environment owner.
default Object	getRepositories()	Any AWS CodeCommit source code repositories to be cloned into the development environment.
default String	getSubnetId()	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.
default List<CfnTag>	getTags()	An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutomaticStopTimeMinutes

@Stability(Stable)
@Nullable
default Number getAutomaticStopTimeMinutes()

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

See Also:

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

getConnectionType

@Stability(Stable)
@Nullable
default String getConnectionType()

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

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the environment to create.

See Also:

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

getImageId

@Stability(Stable)
@Nullable
default String getImageId()

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.

From December 04, 2023, you will be required to include the ImageId parameter for the CreateEnvironmentEC2 action. This change will be reflected across all direct methods of communicating with the API, such as AWS SDK, AWS CLI and AWS CloudFormation. This change will only affect direct API consumers, and not AWS Cloud9 console users.

Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.

AMI aliases

• Amazon Linux 2: amazonlinux-2-x86_64
• Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64
• Ubuntu 18.04: ubuntu-18.04-x86_64
• Ubuntu 22.04: ubuntu-22.04-x86_64

SSM paths

• Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64
• Amazon Linux 2023 (recommended): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64
• Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64
• Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64

See Also:

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

getInstanceType

@Stability(Stable)
@Nullable
default String getInstanceType()

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

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the environment.

See Also:

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

getOwnerArn

@Stability(Stable)
@Nullable
default String getOwnerArn()

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.

See Also:

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

getRepositories

@Stability(Stable)
@Nullable
default Object getRepositories()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEnvironmentEC2PropsMixin.RepositoryProperty>

See Also:

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

getSubnetId

@Stability(Stable)
@Nullable
default String getSubnetId()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnEnvironmentEC2MixinProps.Builder builder()

Returns:

a CfnEnvironmentEC2MixinProps.Builder of CfnEnvironmentEC2MixinProps