Package software.amazon.awssdk.services.cloud9.model

Class CreateEnvironmentEc2Request

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloud9.model.Cloud9Request

software.amazon.awssdk.services.cloud9.model.CreateEnvironmentEc2Request

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEnvironmentEc2Request.Builder,CreateEnvironmentEc2Request>

@Generated("software.amazon.awssdk:codegen")
public final class CreateEnvironmentEc2Request
extends Cloud9Request
implements ToCopyableBuilder<CreateEnvironmentEc2Request.Builder,CreateEnvironmentEc2Request>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateEnvironmentEc2Request.Builder

Method Summary

Modifier and Type	Method	Description
Integer	automaticStopTimeMinutes()	The number of minutes until the running instance is shut down after the environment has last been used.
static CreateEnvironmentEc2Request.Builder	builder()
String	clientRequestToken()	A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.
ConnectionType	connectionType()	The connection type used for connecting to an Amazon EC2 environment.
String	connectionTypeAsString()	The connection type used for connecting to an Amazon EC2 environment.
String	description()	The description of the environment to create.
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	imageId()	The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
String	instanceType()	The type of instance to connect to the environment (for example, t2.micro).
String	name()	The name of the environment to create.
String	ownerArn()	The Amazon Resource Name (ARN) of the environment owner.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEnvironmentEc2Request.Builder>	serializableBuilderClass()
String	subnetId()	The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
List<Tag>	tags()	An array of key-value pairs that will be associated with the new Cloud9 development environment.
CreateEnvironmentEc2Request.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the environment to create.

This name is visible to other IAM users in the same Amazon Web Services account.

Returns:

The name of the environment to create.

This name is visible to other IAM users in the same Amazon Web Services account.

description

public final String description()

The description of the environment to create.

Returns:

The description of the environment to create.

clientRequestToken

public final String clientRequestToken()

A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.

For more information, see Client Tokens in the Amazon EC2 API Reference.

Returns:

A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.

For more information, see Client Tokens in the Amazon EC2 API Reference.

instanceType

public final String instanceType()

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

Returns:

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

subnetId

public final String subnetId()

The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.

Returns:

The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.

imageId

public final String imageId()

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 Amazon EC2 Systems Manager (SSM) 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 Amazon Web Services SDK, Amazon Web Services CLI and Amazon Web Services CloudFormation. This change will only affect direct API consumers, and not Cloud9 console users.

We recommend using Amazon Linux 2023 as the AMI to create your environment as it is fully supported.

Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.

AMI aliases

• Amazon Linux 2: amazonlinux-2-x86_64

• Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64

• Ubuntu 18.04: ubuntu-18.04-x86_64

• Ubuntu 22.04: ubuntu-22.04-x86_64

SSM paths

• Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64

• Amazon Linux 2023 (recommended): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64

• Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64

• Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64

Returns:

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 Amazon EC2 Systems Manager (SSM) 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 Amazon Web Services SDK, Amazon Web Services CLI and Amazon Web Services CloudFormation. This change will only affect direct API consumers, and not Cloud9 console users.

We recommend using Amazon Linux 2023 as the AMI to create your environment as it is fully supported.

Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.

AMI aliases

• Amazon Linux 2: amazonlinux-2-x86_64

• Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64

• Ubuntu 18.04: ubuntu-18.04-x86_64

• Ubuntu 22.04: ubuntu-22.04-x86_64

SSM paths

• Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64

• Amazon Linux 2023 (recommended): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64

• Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64

• Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64

automaticStopTimeMinutes

public final Integer automaticStopTimeMinutes()

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

Returns:

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

ownerArn

public final String ownerArn()

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

Returns:

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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

connectionType

public final ConnectionType connectionType()

The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon EC2 Systems Manager).

For more information, see Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager in the Cloud9 User Guide.

If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().

Returns:

The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon EC2 Systems Manager).

For more information, see Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager in the Cloud9 User Guide.

See Also:

ConnectionType

connectionTypeAsString

public final String connectionTypeAsString()

The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon EC2 Systems Manager).

For more information, see Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager in the Cloud9 User Guide.

If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().

Returns:

The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon EC2 Systems Manager).

For more information, see Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager in the Cloud9 User Guide.

See Also:

ConnectionType

dryRun

public final Boolean dryRun()

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

toBuilder

public CreateEnvironmentEc2Request.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEnvironmentEc2Request.Builder,CreateEnvironmentEc2Request>

Specified by:

toBuilder in class Cloud9Request

builder

public static CreateEnvironmentEc2Request.Builder builder()

serializableBuilderClass

public static Class<? extends CreateEnvironmentEc2Request.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo