Interface CfnEnvironmentEC2Props
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnEnvironmentEC2Props.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:40.074Z")
@Stability(Stable)
public interface CfnEnvironmentEC2Props
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.cloud9.*; CfnEnvironmentEC2Props cfnEnvironmentEC2Props = CfnEnvironmentEC2Props.builder() .instanceType("instanceType") // the properties below are optional .automaticStopTimeMinutes(123) .connectionType("connectionType") .description("description") .imageId("imageId") .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();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnEnvironmentEC2Props
static final class
An implementation forCfnEnvironmentEC2Props
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Number
The number of minutes until the running instance is shut down after the environment was last used.default String
The connection type used for connecting to an Amazon EC2 environment.default String
The description of the environment to create.default String
The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.The type of instance to connect to the environment (for example,t2.micro
).default String
getName()
The name of the environment.default String
The Amazon Resource Name (ARN) of the environment owner.default Object
Any AWS CodeCommit source code repositories to be cloned into the development environment.default 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.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
-
getInstanceType
The type of instance to connect to the environment (for example,t2.micro
). -
getAutomaticStopTimeMinutes
The number of minutes until the running instance is shut down after the environment was last used. -
getConnectionType
The connection type used for connecting to an Amazon EC2 environment.Valid values are
CONNECT_SSH
(default) andCONNECT_SSM
(connected through AWS Systems Manager ). -
getDescription
The description of the environment to create. -
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.
The default AMI is used if the parameter isn't explicitly assigned a value in the request.
AMI aliases
- Amazon Linux (default):
amazonlinux-1-x86_64
- Amazon Linux 2:
amazonlinux-2-x86_64
- Ubuntu 18.04:
ubuntu-18.04-x86_64
SSM paths
- Amazon Linux (default):
resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64
- Amazon Linux 2:
resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64
- Ubuntu 18.04:
resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64
- Amazon Linux (default):
-
getName
The name of the environment. -
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.
-
getRepositories
Any AWS CodeCommit source code repositories to be cloned into the development environment. -
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. -
getTags
An array of key-value pairs that will be associated with the new AWS Cloud9 development environment. -
builder
- Returns:
- a
CfnEnvironmentEC2Props.Builder
ofCfnEnvironmentEC2Props
-