Class Environment
- java.lang.Object
-
- software.amazon.awssdk.services.cloud9.model.Environment
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Environment.Builder,Environment>
@Generated("software.amazon.awssdk:codegen") public final class Environment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Environment.Builder,Environment>
Information about an Cloud9 development environment.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceEnvironment.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) of the environment.static Environment.Builderbuilder()ConnectionTypeconnectionType()The connection type used for connecting to an Amazon EC2 environment.StringconnectionTypeAsString()The connection type used for connecting to an Amazon EC2 environment.Stringdescription()The description for the environment.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringid()The ID of the environment.EnvironmentLifecyclelifecycle()The state of the environment in its creation or deletion lifecycle.ManagedCredentialsStatusmanagedCredentialsStatus()Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment.StringmanagedCredentialsStatusAsString()Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment.Stringname()The name of the environment.StringownerArn()The Amazon Resource Name (ARN) of the environment owner.List<SdkField<?>>sdkFields()static Class<? extends Environment.Builder>serializableBuilderClass()Environment.BuildertoBuilder()StringtoString()Returns a string representation of this object.EnvironmentTypetype()The type of environment.StringtypeAsString()The type of environment.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
id
public final String id()
The ID of the environment.
- Returns:
- The ID of the environment.
-
name
public final String name()
The name of the environment.
- Returns:
- The name of the environment.
-
description
public final String description()
The description for the environment.
- Returns:
- The description for the environment.
-
type
public final EnvironmentType 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,
typewill 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:
EnvironmentType
-
-
typeAsString
public final String 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,
typewill 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:
EnvironmentType
-
-
connectionType
public final ConnectionType connectionType()
The connection type used for connecting to an Amazon EC2 environment.
CONNECT_SSHis selected by default.If the service returns an enum value that is not available in the current SDK version,
connectionTypewill 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_SSHis selected by default. - See Also:
ConnectionType
-
connectionTypeAsString
public final String connectionTypeAsString()
The connection type used for connecting to an Amazon EC2 environment.
CONNECT_SSHis selected by default.If the service returns an enum value that is not available in the current SDK version,
connectionTypewill 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_SSHis selected by default. - See Also:
ConnectionType
-
arn
public final String arn()
The Amazon Resource Name (ARN) of the environment.
- Returns:
- The Amazon Resource Name (ARN) of the environment.
-
ownerArn
public final String ownerArn()
The Amazon Resource Name (ARN) of the environment owner.
- Returns:
- The Amazon Resource Name (ARN) of the environment owner.
-
lifecycle
public final EnvironmentLifecycle 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
public final ManagedCredentialsStatus 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,
managedCredentialsStatuswill 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:
ManagedCredentialsStatus
-
-
managedCredentialsStatusAsString
public final String 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,
managedCredentialsStatuswill 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:
ManagedCredentialsStatus
-
-
toBuilder
public Environment.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Environment.Builder,Environment>
-
builder
public static Environment.Builder builder()
-
serializableBuilderClass
public static Class<? extends Environment.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
-