Class Environment

java.lang.Object
software.amazon.awssdk.services.finspace.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>

Represents an FinSpace environment.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the FinSpace environment.

      Returns:
      The name of the FinSpace environment.

    • environmentId

      public final String environmentId()

      The identifier of the FinSpace environment.

      Returns:
      The identifier of the FinSpace environment.

    • awsAccountId

      public final String awsAccountId()

      The ID of the AWS account in which the FinSpace environment is created.

      Returns:
      The ID of the AWS account in which the FinSpace environment is created.

    • status

      public final EnvironmentStatus status()

      The current status of creation of the FinSpace environment.

      If the service returns an enum value that is not available in the current SDK version, status will return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of creation of the FinSpace environment.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of creation of the FinSpace environment.

      If the service returns an enum value that is not available in the current SDK version, status will return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of creation of the FinSpace environment.
      See Also:

    • environmentUrl

      public final String environmentUrl()

      The sign-in URL for the web application of your FinSpace environment.

      Returns:
      The sign-in URL for the web application of your FinSpace environment.

    • description

      public final String description()

      The description of the FinSpace environment.

      Returns:
      The description of the FinSpace environment.

    • environmentArn

      public final String environmentArn()

      The Amazon Resource Name (ARN) of your FinSpace environment.

      Returns:
      The Amazon Resource Name (ARN) of your FinSpace environment.

    • sageMakerStudioDomainUrl

      public final String sageMakerStudioDomainUrl()

      The URL of the integrated FinSpace notebook environment in your web application.

      Returns:
      The URL of the integrated FinSpace notebook environment in your web application.

    • kmsKeyId

      public final String kmsKeyId()

      The KMS key id used to encrypt in the FinSpace environment.

      Returns:
      The KMS key id used to encrypt in the FinSpace environment.

    • dedicatedServiceAccountId

      public final String dedicatedServiceAccountId()

      The AWS account ID of the dedicated service account associated with your FinSpace environment.

      Returns:
      The AWS account ID of the dedicated service account associated with your FinSpace environment.

    • federationMode

      public final FederationMode federationMode()

      The authentication mode for the environment.

      If the service returns an enum value that is not available in the current SDK version, federationMode will return FederationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from federationModeAsString().

      Returns:
      The authentication mode for the environment.
      See Also:

    • federationModeAsString

      public final String federationModeAsString()

      The authentication mode for the environment.

      If the service returns an enum value that is not available in the current SDK version, federationMode will return FederationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from federationModeAsString().

      Returns:
      The authentication mode for the environment.
      See Also:

    • federationParameters

      public final FederationParameters federationParameters()

      Configuration information when authentication mode is FEDERATED.

      Returns:
      Configuration information when authentication mode is FEDERATED.

    • toBuilder

      public Environment.Builder 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 interface ToCopyableBuilder<Environment.Builder,Environment>
      Returns:
      a builder for type T

    • 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)
      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 an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.