software.amazon.awscdk.services.cloud9.alpha.Ec2Environment Maven / Gradle / Ivy
Show all versions of cloud9-alpha Show documentation
package software.amazon.awscdk.services.cloud9.alpha;
/**
* (experimental) A Cloud9 Environment with Amazon EC2.
*
* Example:
*
*
* import software.amazon.awscdk.services.iam.*;
* Vpc vpc;
* User user = new User(this, "user");
* user.addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName("AWSCloud9Administrator"));
* Ec2Environment.Builder.create(this, "C9Env")
* .vpc(vpc)
* .imageId(ImageId.AMAZON_LINUX_2)
* .owner(Owner.user(user))
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-18T22:17:05.952Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.cloud9.alpha.$Module.class, fqn = "@aws-cdk/aws-cloud9-alpha.Ec2Environment")
public class Ec2Environment extends software.amazon.awscdk.Resource implements software.amazon.awscdk.services.cloud9.alpha.IEc2Environment {
protected Ec2Environment(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected Ec2Environment(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Ec2Environment(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.cloud9.alpha.Ec2EnvironmentProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* (experimental) import from EnvironmentEc2Name.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param ec2EnvironmentName This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.cloud9.alpha.IEc2Environment fromEc2EnvironmentName(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull java.lang.String ec2EnvironmentName) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.amazon.awscdk.services.cloud9.alpha.Ec2Environment.class, "fromEc2EnvironmentName", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.cloud9.alpha.IEc2Environment.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(ec2EnvironmentName, "ec2EnvironmentName is required") });
}
/**
* (experimental) The environment ARN of this Cloud9 environment.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getEc2EnvironmentArn() {
return software.amazon.jsii.Kernel.get(this, "ec2EnvironmentArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The environment name of this Cloud9 environment.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getEc2EnvironmentName() {
return software.amazon.jsii.Kernel.get(this, "ec2EnvironmentName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The environment ID of this Cloud9 environment.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getEnvironmentId() {
return software.amazon.jsii.Kernel.get(this, "environmentId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The complete IDE URL of this Cloud9 environment.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getIdeUrl() {
return software.amazon.jsii.Kernel.get(this, "ideUrl", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) VPC ID.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ec2.IVpc getVpc() {
return software.amazon.jsii.Kernel.get(this, "vpc", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.ec2.IVpc.class));
}
/**
* (experimental) A fluent builder for {@link software.amazon.awscdk.services.cloud9.alpha.Ec2Environment}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static Builder create(final software.constructs.Construct scope, final java.lang.String id) {
return new Builder(scope, id);
}
private final software.constructs.Construct scope;
private final java.lang.String id;
private final software.amazon.awscdk.services.cloud9.alpha.Ec2EnvironmentProps.Builder props;
private Builder(final software.constructs.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.props = new software.amazon.awscdk.services.cloud9.alpha.Ec2EnvironmentProps.Builder();
}
/**
* (experimental) The image ID used for creating an Amazon EC2 environment.
*
* @return {@code this}
* @param imageId The image ID used for creating an Amazon EC2 environment. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder imageId(final software.amazon.awscdk.services.cloud9.alpha.ImageId imageId) {
this.props.imageId(imageId);
return this;
}
/**
* (experimental) The VPC that AWS Cloud9 will use to communicate with the Amazon Elastic Compute Cloud (Amazon EC2) instance.
*
* @return {@code this}
* @param vpc The VPC that AWS Cloud9 will use to communicate with the Amazon Elastic Compute Cloud (Amazon EC2) instance. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder vpc(final software.amazon.awscdk.services.ec2.IVpc vpc) {
this.props.vpc(vpc);
return this;
}
/**
* (experimental) The number of minutes until the running instance is shut down after the environment was last used.
*
* Setting a value of 0 means the instance will never be automatically shut down."
*
* Default: - The instance will not be shut down automatically.
*
* @return {@code this}
* @param automaticStop The number of minutes until the running instance is shut down after the environment was last used. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder automaticStop(final software.amazon.awscdk.Duration automaticStop) {
this.props.automaticStop(automaticStop);
return this;
}
/**
* (experimental) The AWS CodeCommit repository to be cloned.
*
* Default: - do not clone any repository
*
* @return {@code this}
* @param clonedRepositories The AWS CodeCommit repository to be cloned. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder clonedRepositories(final java.util.List clonedRepositories) {
this.props.clonedRepositories(clonedRepositories);
return this;
}
/**
* (experimental) 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)
*
* Default: - CONNECT_SSH
*
* @return {@code this}
* @param connectionType The connection type used for connecting to an Amazon EC2 environment. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder connectionType(final software.amazon.awscdk.services.cloud9.alpha.ConnectionType connectionType) {
this.props.connectionType(connectionType);
return this;
}
/**
* (experimental) Description of the environment.
*
* Default: - no description
*
* @return {@code this}
* @param description Description of the environment. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder description(final java.lang.String description) {
this.props.description(description);
return this;
}
/**
* (experimental) Name of the environment.
*
* Default: - automatically generated name
*
* @return {@code this}
* @param ec2EnvironmentName Name of the environment. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder ec2EnvironmentName(final java.lang.String ec2EnvironmentName) {
this.props.ec2EnvironmentName(ec2EnvironmentName);
return this;
}
/**
* (experimental) The type of instance to connect to the environment.
*
* Default: - t2.micro
*
* @return {@code this}
* @param instanceType The type of instance to connect to the environment. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder instanceType(final software.amazon.awscdk.services.ec2.InstanceType instanceType) {
this.props.instanceType(instanceType);
return this;
}
/**
* (experimental) Owner of the environment.
*
* The owner has full control of the environment and can invite additional members.
*
* Default: - The identity that CloudFormation executes under will be the owner
*
* @return {@code this}
* @param owner Owner of the environment. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder owner(final software.amazon.awscdk.services.cloud9.alpha.Owner owner) {
this.props.owner(owner);
return this;
}
/**
* (experimental) The subnetSelection of the VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.
*
* Default: - all public subnets of the VPC are selected.
*
* @return {@code this}
* @param subnetSelection The subnetSelection of the VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder subnetSelection(final software.amazon.awscdk.services.ec2.SubnetSelection subnetSelection) {
this.props.subnetSelection(subnetSelection);
return this;
}
/**
* @return a newly built instance of {@link software.amazon.awscdk.services.cloud9.alpha.Ec2Environment}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public software.amazon.awscdk.services.cloud9.alpha.Ec2Environment build() {
return new software.amazon.awscdk.services.cloud9.alpha.Ec2Environment(
this.scope,
this.id,
this.props.build()
);
}
}
}