Class Environment
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Environment.Builder,
Environment>
Represents an FinSpace environment.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID of the AWS account in which the FinSpace environment is created.static Environment.Builder
builder()
final String
The AWS account ID of the dedicated service account associated with your FinSpace environment.final String
The description of the FinSpace environment.final String
The Amazon Resource Name (ARN) of your FinSpace environment.final String
The identifier of the FinSpace environment.final String
The sign-in URL for the web application of your FinSpace environment.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FederationMode
The authentication mode for the environment.final String
The authentication mode for the environment.final FederationParameters
Configuration information when authentication mode is FEDERATED.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
kmsKeyId()
The KMS key id used to encrypt in the FinSpace environment.final String
name()
The name of the FinSpace environment.final String
The URL of the integrated FinSpace notebook environment in your web application.static Class
<? extends Environment.Builder> final EnvironmentStatus
status()
The current status of creation of the FinSpace environment.final String
The current status of creation of the FinSpace environment.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the FinSpace environment.
- Returns:
- The name of the FinSpace environment.
-
environmentId
The identifier of the FinSpace environment.
- Returns:
- The identifier of the FinSpace environment.
-
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
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 returnEnvironmentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of creation of the FinSpace environment.
- See Also:
-
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 returnEnvironmentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of creation of the FinSpace environment.
- See Also:
-
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
The description of the FinSpace environment.
- Returns:
- The description of the FinSpace environment.
-
environmentArn
The Amazon Resource Name (ARN) of your FinSpace environment.
- Returns:
- The Amazon Resource Name (ARN) of your FinSpace environment.
-
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
The KMS key id used to encrypt in the FinSpace environment.
- Returns:
- The KMS key id used to encrypt in the FinSpace environment.
-
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
The authentication mode for the environment.
If the service returns an enum value that is not available in the current SDK version,
federationMode
will returnFederationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfederationModeAsString()
.- Returns:
- The authentication mode for the environment.
- See Also:
-
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 returnFederationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfederationModeAsString()
.- Returns:
- The authentication mode for the environment.
- See Also:
-
federationParameters
Configuration information when authentication mode is FEDERATED.
- Returns:
- Configuration information when authentication mode is FEDERATED.
-
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
-