Environment (AWS Java SDK :: Services :: AWS Cloud9 2.17.46 API)

java.lang.Object
- software.amazon.awssdk.services.cloud9.model.Environment

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Environment.Builder,Environment>

@Generated(value="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 and Description

static interface Environment.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Environment.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the environment.
`static Environment.Builder`	`builder()`
`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 for the environment.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()` The ID of the environment.
`EnvironmentLifecycle`	`lifecycle()` The state of the environment in its creation or deletion lifecycle.
`ManagedCredentialsStatus`	`managedCredentialsStatus()` Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment.
`String`	`managedCredentialsStatusAsString()` Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment.
`String`	`name()` The name of the environment.
`String`	`ownerArn()` The Amazon Resource Name (ARN) of the environment owner.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Environment.Builder>`	`serializableBuilderClass()`
`Environment.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`EnvironmentType`	`type()` The type of environment.
`String`	`typeAsString()` 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, type will return EnvironmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    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, type will return EnvironmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    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_SSH is selected by default.
    
    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().
    
    Returns:
    
    The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH is selected by default.
    
    See Also:
    
    ConnectionType
  - connectionTypeAsString
```
public final String 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 return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().
    
    Returns:
    
    The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH is 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, managedCredentialsStatus will return ManagedCredentialsStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from managedCredentialsStatusAsString().
    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, managedCredentialsStatus will return ManagedCredentialsStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from managedCredentialsStatusAsString().
    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:
    
    toBuilder in interface ToCopyableBuilder<Environment.Builder,Environment>
  - builder
```
public static Environment.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Environment.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Environment

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

name

description

type

typeAsString

connectionType

connectionTypeAsString

arn

ownerArn

lifecycle

managedCredentialsStatus

managedCredentialsStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields