Class CreateEnvironmentEc2Request
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateEnvironmentEc2Request.Builder,
CreateEnvironmentEc2Request>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
The number of minutes until the running instance is shut down after the environment has last been used.builder()
final String
A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.final ConnectionType
The connection type used for connecting to an Amazon EC2 environment.final String
The connection type used for connecting to an Amazon EC2 environment.final String
The description of the environment to create.final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
imageId()
The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.final String
The type of instance to connect to the environment (for example,t2.micro
).final String
name()
The name of the environment to create.final String
ownerArn()
The Amazon Resource Name (ARN) of the environment owner.static Class
<? extends CreateEnvironmentEc2Request.Builder> final String
subnetId()
The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.tags()
An array of key-value pairs that will be associated with the new Cloud9 development environment.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The description of the environment to create.
- Returns:
- The description of the environment to create.
-
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
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
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
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 theCreateEnvironmentEC2
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 theCreateEnvironmentEC2
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
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
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 theisEmpty()
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
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
The connection type used for connecting to an Amazon EC2 environment. Valid values are
CONNECT_SSH
(default) andCONNECT_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 returnConnectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectionTypeAsString()
.- Returns:
- The connection type used for connecting to an Amazon EC2 environment. Valid values are
CONNECT_SSH
(default) andCONNECT_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:
-
connectionTypeAsString
The connection type used for connecting to an Amazon EC2 environment. Valid values are
CONNECT_SSH
(default) andCONNECT_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 returnConnectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectionTypeAsString()
.- Returns:
- The connection type used for connecting to an Amazon EC2 environment. Valid values are
CONNECT_SSH
(default) andCONNECT_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:
-
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 isUnauthorizedOperation
.- 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 isUnauthorizedOperation
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateEnvironmentEc2Request.Builder,
CreateEnvironmentEc2Request> - Specified by:
toBuilder
in classCloud9Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-