software.amazon.awscdk.services.cloud9

Class CfnEnvironmentEC2

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cloud9.CfnEnvironmentEC2

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:15.315Z")
 @Stability(value=Stable)
public class CfnEnvironmentEC2
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cloud9::EnvironmentEC2`.

The AWS::Cloud9::EnvironmentEC2 resource creates an Amazon EC2 development environment in AWS Cloud9 . For more information, see Creating an Environment in the AWS Cloud9 User Guide .

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.*;
 CfnEnvironmentEC2 cfnEnvironmentEC2 = CfnEnvironmentEC2.Builder.create(this, "MyCfnEnvironmentEC2")
         .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

Nested Classes

Modifier and Type	Class and Description
static class	CfnEnvironmentEC2.Builder A fluent builder for CfnEnvironmentEC2.
static interface	CfnEnvironmentEC2.RepositoryProperty The `Repository` property type specifies an AWS CodeCommit source code repository to be cloned into an AWS Cloud9 development environment.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEnvironmentEC2(Construct scope, String id, CfnEnvironmentEC2Props props) Create a new `AWS::Cloud9::EnvironmentEC2`.
protected	CfnEnvironmentEC2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEnvironmentEC2(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the development environment, such as `arn:aws:cloud9:us-east-2:123456789012:environment:2bc3642873c342e485f7e0c561234567` .
String	getAttrName() The name of the environment.
Number	getAutomaticStopTimeMinutes() The number of minutes until the running instance is shut down after the environment was last used.
protected Map<String,Object>	getCfnProperties()
String	getConnectionType() The connection type used for connecting to an Amazon EC2 environment.
String	getDescription() The description of the environment to create.
String	getImageId() The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
String	getInstanceType() The type of instance to connect to the environment (for example, `t2.micro` ).
String	getName() The name of the environment.
String	getOwnerArn() The Amazon Resource Name (ARN) of the environment owner.
Object	getRepositories() Any AWS CodeCommit source code repositories to be cloned into the development environment.
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.
TagManager	getTags() An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutomaticStopTimeMinutes(Number value) The number of minutes until the running instance is shut down after the environment was last used.
void	setConnectionType(String value) The connection type used for connecting to an Amazon EC2 environment.
void	setDescription(String value) The description of the environment to create.
void	setImageId(String value) The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
void	setInstanceType(String value) The type of instance to connect to the environment (for example, `t2.micro` ).
void	setName(String value) The name of the environment.
void	setOwnerArn(String value) The Amazon Resource Name (ARN) of the environment owner.
void	setRepositories(IResolvable value) Any AWS CodeCommit source code repositories to be cloned into the development environment.
void	setRepositories(List<Object> value) Any AWS CodeCommit source code repositories to be cloned into the development environment.
void	setSubnetId(String value) 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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEnvironmentEC2

protected CfnEnvironmentEC2(software.amazon.jsii.JsiiObjectRef objRef)

CfnEnvironmentEC2

protected CfnEnvironmentEC2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEnvironmentEC2

@Stability(value=Stable)
public CfnEnvironmentEC2(@NotNull
                                                  Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnEnvironmentEC2Props props)

Create a new `AWS::Cloud9::EnvironmentEC2`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the development environment, such as `arn:aws:cloud9:us-east-2:123456789012:environment:2bc3642873c342e485f7e0c561234567` .

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

The name of the environment.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getInstanceType

@Stability(value=Stable)
 @NotNull
public String getInstanceType()

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

setInstanceType

@Stability(value=Stable)
public void setInstanceType(@NotNull
                                                     String value)

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

getAutomaticStopTimeMinutes

@Stability(value=Stable)
 @Nullable
public Number getAutomaticStopTimeMinutes()

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

setAutomaticStopTimeMinutes

@Stability(value=Stable)
public void setAutomaticStopTimeMinutes(@Nullable
                                                                 Number value)

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

getConnectionType

@Stability(value=Stable)
 @Nullable
public 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 ).

setConnectionType

@Stability(value=Stable)
public void setConnectionType(@Nullable
                                                       String value)

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(value=Stable)
 @Nullable
public String getDescription()

The description of the environment to create.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the environment to create.

getImageId

@Stability(value=Stable)
 @Nullable
public 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

setImageId

@Stability(value=Stable)
public void setImageId(@Nullable
                                                String value)

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(value=Stable)
 @Nullable
public String getName()

The name of the environment.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the environment.

getOwnerArn

@Stability(value=Stable)
 @Nullable
public 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.

setOwnerArn

@Stability(value=Stable)
public void setOwnerArn(@Nullable
                                                 String value)

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(value=Stable)
 @Nullable
public Object getRepositories()

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

setRepositories

@Stability(value=Stable)
public void setRepositories(@Nullable
                                                     IResolvable value)

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

setRepositories

@Stability(value=Stable)
public void setRepositories(@Nullable
                                                     List<Object> value)

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

getSubnetId

@Stability(value=Stable)
 @Nullable
public 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.

setSubnetId

@Stability(value=Stable)
public void setSubnetId(@Nullable
                                                 String value)

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.