com.amazonaws.services.cloud9.model

Class CreateEnvironmentEC2Request

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloud9.model.CreateEnvironmentEC2Request

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateEnvironmentEC2Request
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateEnvironmentEC2Request()

Method Summary

Modifier and Type	Method and Description
CreateEnvironmentEC2Request	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Integer	getAutomaticStopTimeMinutes() The number of minutes until the running instance is shut down after the environment has last been used.
String	getClientRequestToken() A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.
String	getConnectionType() The connection type used for connecting to an Amazon EC2 environment.
String	getDescription() The description of the environment to create.
Boolean	getDryRun() Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
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 to create.
String	getOwnerArn() The Amazon Resource Name (ARN) of the environment owner.
String	getSubnetId() The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
List<Tag>	getTags() An array of key-value pairs that will be associated with the new Cloud9 development environment.
int	hashCode()
Boolean	isDryRun() Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
void	setAutomaticStopTimeMinutes(Integer automaticStopTimeMinutes) The number of minutes until the running instance is shut down after the environment has last been used.
void	setClientRequestToken(String clientRequestToken) A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.
void	setConnectionType(String connectionType) The connection type used for connecting to an Amazon EC2 environment.
void	setDescription(String description) The description of the environment to create.
void	setDryRun(Boolean dryRun) Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
void	setImageId(String imageId) The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
void	setInstanceType(String instanceType) The type of instance to connect to the environment (for example, t2.micro).
void	setName(String name) The name of the environment to create.
void	setOwnerArn(String ownerArn) The Amazon Resource Name (ARN) of the environment owner.
void	setSubnetId(String subnetId) The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
void	setTags(Collection<Tag> tags) An array of key-value pairs that will be associated with the new Cloud9 development environment.
String	toString() Returns a string representation of this object.
CreateEnvironmentEC2Request	withAutomaticStopTimeMinutes(Integer automaticStopTimeMinutes) The number of minutes until the running instance is shut down after the environment has last been used.
CreateEnvironmentEC2Request	withClientRequestToken(String clientRequestToken) A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.
CreateEnvironmentEC2Request	withConnectionType(ConnectionType connectionType) The connection type used for connecting to an Amazon EC2 environment.
CreateEnvironmentEC2Request	withConnectionType(String connectionType) The connection type used for connecting to an Amazon EC2 environment.
CreateEnvironmentEC2Request	withDescription(String description) The description of the environment to create.
CreateEnvironmentEC2Request	withDryRun(Boolean dryRun) Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
CreateEnvironmentEC2Request	withImageId(String imageId) The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
CreateEnvironmentEC2Request	withInstanceType(String instanceType) The type of instance to connect to the environment (for example, t2.micro).
CreateEnvironmentEC2Request	withName(String name) The name of the environment to create.
CreateEnvironmentEC2Request	withOwnerArn(String ownerArn) The Amazon Resource Name (ARN) of the environment owner.
CreateEnvironmentEC2Request	withSubnetId(String subnetId) The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
CreateEnvironmentEC2Request	withTags(Collection<Tag> tags) An array of key-value pairs that will be associated with the new Cloud9 development environment.
CreateEnvironmentEC2Request	withTags(Tag... tags) An array of key-value pairs that will be associated with the new Cloud9 development environment.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateEnvironmentEC2Request

public CreateEnvironmentEC2Request()

Method Detail

setName

public void setName(String name)

The name of the environment to create.

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

Parameters:

name - The name of the environment to create.

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

getName

public String getName()

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.

withName

public CreateEnvironmentEC2Request withName(String name)

The name of the environment to create.

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

Parameters:

name - The name of the environment to create.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The description of the environment to create.

Parameters:

description - The description of the environment to create.

getDescription

public String getDescription()

The description of the environment to create.

Returns:

The description of the environment to create.

withDescription

public CreateEnvironmentEC2Request withDescription(String description)

The description of the environment to create.

Parameters:

description - The description of the environment to create.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientRequestToken

public void setClientRequestToken(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.

Parameters:

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.

getClientRequestToken

public String getClientRequestToken()

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.

withClientRequestToken

public CreateEnvironmentEC2Request withClientRequestToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setInstanceType

public void setInstanceType(String instanceType)

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

Parameters:

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

getInstanceType

public String getInstanceType()

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

withInstanceType

public CreateEnvironmentEC2Request withInstanceType(String instanceType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSubnetId

public void setSubnetId(String subnetId)

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

Parameters:

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

getSubnetId

public String getSubnetId()

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.

withSubnetId

public CreateEnvironmentEC2Request withSubnetId(String subnetId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setImageId

public void setImageId(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.

The default AMI is used if the parameter isn't explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.

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

Parameters:

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.

The default AMI is used if the parameter isn't explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.

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

getImageId

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 Amazon EC2 Systems Manager (SSM) path.

The default AMI is used if the parameter isn't explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.

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

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.

The default AMI is used if the parameter isn't explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.

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

withImageId

public CreateEnvironmentEC2Request withImageId(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.

The default AMI is used if the parameter isn't explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.

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

Parameters:

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.

The default AMI is used if the parameter isn't explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setAutomaticStopTimeMinutes

public void setAutomaticStopTimeMinutes(Integer automaticStopTimeMinutes)

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

Parameters:

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

getAutomaticStopTimeMinutes

public Integer getAutomaticStopTimeMinutes()

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.

withAutomaticStopTimeMinutes

public CreateEnvironmentEC2Request withAutomaticStopTimeMinutes(Integer automaticStopTimeMinutes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setOwnerArn

public void setOwnerArn(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.

Parameters:

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.

getOwnerArn

public String getOwnerArn()

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.

withOwnerArn

public CreateEnvironmentEC2Request withOwnerArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(Collection<Tag> tags)

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

Parameters:

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

withTags

public CreateEnvironmentEC2Request withTags(Tag... tags)

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

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateEnvironmentEC2Request withTags(Collection<Tag> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setConnectionType

public void setConnectionType(String 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.

Parameters:

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.

See Also:

ConnectionType

getConnectionType

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 Amazon EC2 Systems Manager).

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

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

withConnectionType

public CreateEnvironmentEC2Request withConnectionType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConnectionType

withConnectionType

public CreateEnvironmentEC2Request withConnectionType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConnectionType

setDryRun

public void setDryRun(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.

Parameters:

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.

getDryRun

public Boolean getDryRun()

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.

withDryRun

public CreateEnvironmentEC2Request withDryRun(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

isDryRun

public Boolean isDryRun()

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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateEnvironmentEC2Request clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()