software.amazon.awssdk.services.finspace.model

Class Environment

java.lang.Object

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

Represents an FinSpace environment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Environment.Builder

Method Summary

Modifier and Type	Method and Description
String	awsAccountId() The ID of the AWS account in which the FinSpace environment is created.
static Environment.Builder	builder()
String	dedicatedServiceAccountId() The AWS account ID of the dedicated service account associated with your FinSpace environment.
String	description() The description of the FinSpace environment.
String	environmentArn() The Amazon Resource Name (ARN) of your FinSpace environment.
String	environmentId() The identifier of the FinSpace environment.
String	environmentUrl() The sign-in url for the web application of your FinSpace environment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FederationMode	federationMode() The authentication mode for the environment.
String	federationModeAsString() The authentication mode for the environment.
FederationParameters	federationParameters() Configuration information when authentication mode is FEDERATED.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId() The KMS key id used to encrypt in the FinSpace environment.
String	name() The name of the FinSpace environment.
String	sageMakerStudioDomainUrl() The url of the integrated FinSpace notebook environment in your web application.
List<SdkField<?>>	sdkFields()
static Class<? extends Environment.Builder>	serializableBuilderClass()
EnvironmentStatus	status() The current status of creation of the FinSpace environment.
String	statusAsString() The current status of creation of the FinSpace environment.
Environment.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

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:

EnvironmentStatus

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:

EnvironmentStatus

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:

FederationMode

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:

FederationMode

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()

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