Class CfnEnvironmentEC2Props
Properties for defining a CfnEnvironmentEC2
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Cloud9
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEnvironmentEC2Props : Object, ICfnEnvironmentEC2Props
Syntax (vb)
Public Class CfnEnvironmentEC2Props
Inherits Object
Implements ICfnEnvironmentEC2Props
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cloud9;
var cfnEnvironmentEC2Props = new CfnEnvironmentEC2Props {
ImageId = "imageId",
InstanceType = "instanceType",
// the properties below are optional
AutomaticStopTimeMinutes = 123,
ConnectionType = "connectionType",
Description = "description",
Name = "name",
OwnerArn = "ownerArn",
Repositories = new [] { new RepositoryProperty {
PathComponent = "pathComponent",
RepositoryUrl = "repositoryUrl"
} },
SubnetId = "subnetId",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
Cfn |
Properties
Automatic |
The number of minutes until the running instance is shut down after the environment was last used. |
Connection |
The connection type used for connecting to an Amazon EC2 environment. |
Description | The description of the environment to create. |
Image |
The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. |
Instance |
The type of instance to connect to the environment (for example, |
Name | The name of the environment. |
Owner |
The Amazon Resource Name (ARN) of the environment owner. |
Repositories | Any AWS CodeCommit source code repositories to be cloned into the development environment. |
Subnet |
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 | An array of key-value pairs that will be associated with the new AWS Cloud9 development environment. |
Constructors
CfnEnvironmentEC2Props()
public CfnEnvironmentEC2Props()
Properties
AutomaticStopTimeMinutes
The number of minutes until the running instance is shut down after the environment was last used.
public Nullable<double> AutomaticStopTimeMinutes { get; set; }
Property Value
System.
Remarks
ConnectionType
The connection type used for connecting to an Amazon EC2 environment.
public string ConnectionType { get; set; }
Property Value
System.
Remarks
Valid values are CONNECT_SSH
(default) and CONNECT_SSM
(connected through AWS Systems Manager ).
Description
The description of the environment to create.
public string Description { get; set; }
Property Value
System.
Remarks
ImageId
The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
public string ImageId { get; set; }
Property Value
System.
Remarks
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
SSM paths
InstanceType
The type of instance to connect to the environment (for example, t2.micro
).
public string InstanceType { get; set; }
Property Value
System.
Remarks
Name
The name of the environment.
public string Name { get; set; }
Property Value
System.
Remarks
OwnerArn
The Amazon Resource Name (ARN) of the environment owner.
public string OwnerArn { get; set; }
Property Value
System.
Remarks
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
Any AWS CodeCommit source code repositories to be cloned into the development environment.
public object Repositories { get; set; }
Property Value
System.
Remarks
SubnetId
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.
public string SubnetId { get; set; }
Property Value
System.
Remarks
Tags
An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.
public ICfnTag[] Tags { get; set; }
Property Value
ICfn