@Generated(value="software.amazon.awssdk:codegen") public final class CreateEnvironmentEc2Request extends Cloud9Request implements ToCopyableBuilder<CreateEnvironmentEc2Request.Builder,CreateEnvironmentEc2Request>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateEnvironmentEc2Request.Builder |
Modifier and Type | Method and 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 AWS 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 |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
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 AWS 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 AWS Cloud9 development environment.
|
CreateEnvironmentEc2Request.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final String name()
The name of the environment to create.
This name is visible to other AWS IAM users in the same AWS account.
This name is visible to other AWS IAM users in the same AWS account.
public final String description()
The description of the environment to create.
public final String clientRequestToken()
A unique, case-sensitive string that helps AWS 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 final String instanceType()
The type of instance to connect to the environment (for example, t2.micro
).
t2.micro
).public final String subnetId()
The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.
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 AWS Systems Manager (SSM) path.
The default AMI is used if the parameter isn't explicitly assigned a value in the request.
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
The default AMI is used if the parameter isn't explicitly assigned a value in the request.
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
public final Integer automaticStopTimeMinutes()
The number of minutes until the running instance is shut down after the environment has last been used.
public final String ownerArn()
The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator.
public final boolean hasTags()
public final List<Tag> tags()
An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
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 AWS Systems Manager).
For more information, see Accessing no-ingress EC2 instances with AWS Systems Manager in the AWS 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()
.
CONNECT_SSH
(default) and CONNECT_SSM
(connected through AWS Systems
Manager).
For more information, see Accessing no-ingress EC2 instances with AWS Systems Manager in the AWS Cloud9 User Guide.
ConnectionType
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 AWS Systems Manager).
For more information, see Accessing no-ingress EC2 instances with AWS Systems Manager in the AWS 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()
.
CONNECT_SSH
(default) and CONNECT_SSM
(connected through AWS Systems
Manager).
For more information, see Accessing no-ingress EC2 instances with AWS Systems Manager in the AWS Cloud9 User Guide.
ConnectionType
public CreateEnvironmentEc2Request.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateEnvironmentEc2Request.Builder,CreateEnvironmentEc2Request>
toBuilder
in class Cloud9Request
public static CreateEnvironmentEc2Request.Builder builder()
public static Class<? extends CreateEnvironmentEc2Request.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.