Class Environment
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Environment.Builder,
Environment>
Information about an Cloud9 development environment.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the environment.static Environment.Builder
builder()
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 for the environment.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) final int
hashCode()
final String
id()
The ID of the environment.final EnvironmentLifecycle
The state of the environment in its creation or deletion lifecycle.final ManagedCredentialsStatus
Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment.final String
Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment.final String
name()
The name of the environment.final String
ownerArn()
The Amazon Resource Name (ARN) of the environment owner.static Class
<? extends Environment.Builder> 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.final EnvironmentType
type()
The type of environment.final String
The type of environment.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID of the environment.
- Returns:
- The ID of the environment.
-
name
The name of the environment.
- Returns:
- The name of the environment.
-
description
The description for the environment.
- Returns:
- The description for the environment.
-
type
The type of environment. Valid values include the following:
-
ec2
: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment. -
ssh
: Your own server connects to the environment.
If the service returns an enum value that is not available in the current SDK version,
type
will returnEnvironmentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of environment. Valid values include the following:
-
ec2
: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment. -
ssh
: Your own server connects to the environment.
-
- See Also:
-
-
typeAsString
The type of environment. Valid values include the following:
-
ec2
: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment. -
ssh
: Your own server connects to the environment.
If the service returns an enum value that is not available in the current SDK version,
type
will returnEnvironmentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of environment. Valid values include the following:
-
ec2
: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment. -
ssh
: Your own server connects to the environment.
-
- See Also:
-
-
connectionType
The connection type used for connecting to an Amazon EC2 environment.
CONNECT_SSH
is selected by default.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.
CONNECT_SSH
is selected by default. - See Also:
-
connectionTypeAsString
The connection type used for connecting to an Amazon EC2 environment.
CONNECT_SSH
is selected by default.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.
CONNECT_SSH
is selected by default. - See Also:
-
arn
The Amazon Resource Name (ARN) of the environment.
- Returns:
- The Amazon Resource Name (ARN) of the environment.
-
ownerArn
The Amazon Resource Name (ARN) of the environment owner.
- Returns:
- The Amazon Resource Name (ARN) of the environment owner.
-
lifecycle
The state of the environment in its creation or deletion lifecycle.
- Returns:
- The state of the environment in its creation or deletion lifecycle.
-
managedCredentialsStatus
Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are:
-
ENABLED_ON_CREATE
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
-
DISABLED_BY_OWNER
-
DISABLED_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_OWNER
-
FAILED_REMOVAL_BY_COLLABORATOR
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
If the service returns an enum value that is not available in the current SDK version,
managedCredentialsStatus
will returnManagedCredentialsStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagedCredentialsStatusAsString()
.- Returns:
- Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment.
Available values are:
-
ENABLED_ON_CREATE
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
-
DISABLED_BY_OWNER
-
DISABLED_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_OWNER
-
FAILED_REMOVAL_BY_COLLABORATOR
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
-
- See Also:
-
-
managedCredentialsStatusAsString
Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are:
-
ENABLED_ON_CREATE
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
-
DISABLED_BY_OWNER
-
DISABLED_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_OWNER
-
FAILED_REMOVAL_BY_COLLABORATOR
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
If the service returns an enum value that is not available in the current SDK version,
managedCredentialsStatus
will returnManagedCredentialsStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagedCredentialsStatusAsString()
.- Returns:
- Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment.
Available values are:
-
ENABLED_ON_CREATE
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
-
DISABLED_BY_OWNER
-
DISABLED_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_OWNER
-
FAILED_REMOVAL_BY_COLLABORATOR
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
-
- See Also:
-
-
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<Environment.Builder,
Environment> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-