@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateEnvironmentEC2Request extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateEnvironmentEC2Request() |
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.
|
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
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.
name
- The name of the environment to create.
This name is visible to other IAM users in the same Amazon Web Services account.
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.
This name is visible to other IAM users in the same Amazon Web Services account.
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.
name
- The name of the environment to create.
This name is visible to other IAM users in the same Amazon Web Services account.
public void setDescription(String description)
The description of the environment to create.
description
- The description of the environment to create.public String getDescription()
The description of the environment to create.
public CreateEnvironmentEC2Request withDescription(String description)
The description of the environment to create.
description
- The description of the environment to create.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.
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.
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.
For more information, see Client Tokens in the Amazon EC2 API Reference.
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.
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.
public void setInstanceType(String instanceType)
The type of instance to connect to the environment (for example, t2.micro
).
instanceType
- The type of instance to connect to the environment (for example, t2.micro
).public String getInstanceType()
The type of instance to connect to the environment (for example, t2.micro
).
t2.micro
).public CreateEnvironmentEC2Request withInstanceType(String instanceType)
The type of instance to connect to the environment (for example, t2.micro
).
instanceType
- The type of instance to connect to the environment (for example, t2.micro
).public void setSubnetId(String subnetId)
The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
subnetId
- The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.public String getSubnetId()
The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
public CreateEnvironmentEC2Request withSubnetId(String subnetId)
The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
subnetId
- The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.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.
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
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
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.
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
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
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.
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
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
public void setAutomaticStopTimeMinutes(Integer automaticStopTimeMinutes)
The number of minutes until the running instance is shut down after the environment has last been used.
automaticStopTimeMinutes
- The number of minutes until the running instance is shut down after the environment has last been used.public Integer getAutomaticStopTimeMinutes()
The number of minutes until the running instance is shut down after the environment has last been used.
public CreateEnvironmentEC2Request withAutomaticStopTimeMinutes(Integer automaticStopTimeMinutes)
The number of minutes until the running instance is shut down after the environment has last been used.
automaticStopTimeMinutes
- The number of minutes until the running instance is shut down after the environment has last been used.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.
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.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.
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.
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.public List<Tag> getTags()
An array of key-value pairs that will be associated with the new Cloud9 development environment.
public void setTags(Collection<Tag> tags)
An array of key-value pairs that will be associated with the new Cloud9 development environment.
tags
- An array of key-value pairs that will be associated with the new Cloud9 development environment.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.
tags
- An array of key-value pairs that will be associated with the new Cloud9 development environment.public CreateEnvironmentEC2Request withTags(Collection<Tag> tags)
An array of key-value pairs that will be associated with the new Cloud9 development environment.
tags
- An array of key-value pairs that will be associated with the new Cloud9 development environment.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.
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.
ConnectionType
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.
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.
ConnectionType
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.
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.
ConnectionType
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.
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.
ConnectionType
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
.
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
.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
.
DryRunOperation
. Otherwise, it is UnauthorizedOperation
.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
.
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
.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
.
DryRunOperation
. Otherwise, it is UnauthorizedOperation
.public String toString()
toString
in class Object
Object.toString()
public CreateEnvironmentEC2Request clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()