interface CfnEnvironmentEC2Props
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Cloud9.CfnEnvironmentEC2Props |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscloud9#CfnEnvironmentEC2Props |
![]() | software.amazon.awscdk.services.cloud9.CfnEnvironmentEC2Props |
![]() | aws_cdk.aws_cloud9.CfnEnvironmentEC2Props |
![]() | aws-cdk-lib » aws_cloud9 » CfnEnvironmentEC2Props |
Properties for defining a CfnEnvironmentEC2
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloud9 as cloud9 } from 'aws-cdk-lib';
const cfnEnvironmentEC2Props: cloud9.CfnEnvironmentEC2Props = {
imageId: 'imageId',
instanceType: 'instanceType',
// the properties below are optional
automaticStopTimeMinutes: 123,
connectionType: 'connectionType',
description: 'description',
name: 'name',
ownerArn: 'ownerArn',
repositories: [{
pathComponent: 'pathComponent',
repositoryUrl: 'repositoryUrl',
}],
subnetId: 'subnetId',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
image | string | The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. |
instance | string | The type of instance to connect to the environment (for example, t2.micro ). |
automatic | number | The number of minutes until the running instance is shut down after the environment was last used. |
connection | string | The connection type used for connecting to an Amazon EC2 environment. |
description? | string | The description of the environment to create. |
name? | string | The name of the environment. |
owner | string | The Amazon Resource Name (ARN) of the environment owner. |
repositories? | IResolvable | IResolvable | Repository [] | Any AWS CodeCommit source code repositories to be cloned into the development environment. |
subnet | string | 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? | Cfn [] | An array of key-value pairs that will be associated with the new AWS Cloud9 development environment. |
imageId
Type:
string
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
instanceType
Type:
string
The type of instance to connect to the environment (for example, t2.micro
).
automaticStopTimeMinutes?
Type:
number
(optional)
The number of minutes until the running instance is shut down after the environment was last used.
connectionType?
Type:
string
(optional)
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)
The description of the environment to create.
name?
Type:
string
(optional)
The name of the environment.
ownerArn?
Type:
string
(optional)
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?
Type:
IResolvable
|
IResolvable
|
Repository
[]
(optional)
Any AWS CodeCommit source code repositories to be cloned into the development environment.
subnetId?
Type:
string
(optional)
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?
Type:
Cfn
[]
(optional)
An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.