Package software.amazon.awscdk.services.cloud9

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();

  • Method Details

    • getInstanceType

      @Stability(Stable) @NotNull String getInstanceType()
      The type of instance to connect to the environment (for example, t2.micro ).

    • getAutomaticStopTimeMinutes

      @Stability(Stable) @Nullable default Number getAutomaticStopTimeMinutes()
      The number of minutes until the running instance is shut down after the environment was last used.

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

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the environment to create.

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

      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

    • getName

      @Stability(Stable) @Nullable default String getName()
      The name of the environment.

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

    • getRepositories

      @Stability(Stable) @Nullable default Object getRepositories()
      Any AWS CodeCommit source code repositories to be cloned into the development environment.

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

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

    • builder

      @Stability(Stable) static CfnEnvironmentEC2Props.Builder builder()
      Returns:
      a CfnEnvironmentEC2Props.Builder of CfnEnvironmentEC2Props