Environment (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.finspace.model.Environment

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Environment
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents an FinSpace environment.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Environment()

Constructors
Constructor and Description
`Environment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Environment`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAwsAccountId()` The ID of the AWS account in which the FinSpace environment is created.
`String`	`getDedicatedServiceAccountId()` The AWS account ID of the dedicated service account associated with your FinSpace environment.
`String`	`getDescription()` The description of the FinSpace environment.
`String`	`getEnvironmentArn()` The Amazon Resource Name (ARN) of your FinSpace environment.
`String`	`getEnvironmentId()` The identifier of the FinSpace environment.
`String`	`getEnvironmentUrl()` The sign-in url for the web application of your FinSpace environment.
`String`	`getFederationMode()` The authentication mode for the environment.
`FederationParameters`	`getFederationParameters()` Configuration information when authentication mode is FEDERATED.
`String`	`getKmsKeyId()` The KMS key id used to encrypt in the FinSpace environment.
`String`	`getName()` The name of the FinSpace environment.
`String`	`getSageMakerStudioDomainUrl()` The url of the integrated FinSpace notebook environment in your web application.
`String`	`getStatus()` The current status of creation of the FinSpace environment.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAwsAccountId(String awsAccountId)` The ID of the AWS account in which the FinSpace environment is created.
`void`	`setDedicatedServiceAccountId(String dedicatedServiceAccountId)` The AWS account ID of the dedicated service account associated with your FinSpace environment.
`void`	`setDescription(String description)` The description of the FinSpace environment.
`void`	`setEnvironmentArn(String environmentArn)` The Amazon Resource Name (ARN) of your FinSpace environment.
`void`	`setEnvironmentId(String environmentId)` The identifier of the FinSpace environment.
`void`	`setEnvironmentUrl(String environmentUrl)` The sign-in url for the web application of your FinSpace environment.
`void`	`setFederationMode(String federationMode)` The authentication mode for the environment.
`void`	`setFederationParameters(FederationParameters federationParameters)` Configuration information when authentication mode is FEDERATED.
`void`	`setKmsKeyId(String kmsKeyId)` The KMS key id used to encrypt in the FinSpace environment.
`void`	`setName(String name)` The name of the FinSpace environment.
`void`	`setSageMakerStudioDomainUrl(String sageMakerStudioDomainUrl)` The url of the integrated FinSpace notebook environment in your web application.
`void`	`setStatus(String status)` The current status of creation of the FinSpace environment.
`String`	`toString()` Returns a string representation of this object.
`Environment`	`withAwsAccountId(String awsAccountId)` The ID of the AWS account in which the FinSpace environment is created.
`Environment`	`withDedicatedServiceAccountId(String dedicatedServiceAccountId)` The AWS account ID of the dedicated service account associated with your FinSpace environment.
`Environment`	`withDescription(String description)` The description of the FinSpace environment.
`Environment`	`withEnvironmentArn(String environmentArn)` The Amazon Resource Name (ARN) of your FinSpace environment.
`Environment`	`withEnvironmentId(String environmentId)` The identifier of the FinSpace environment.
`Environment`	`withEnvironmentUrl(String environmentUrl)` The sign-in url for the web application of your FinSpace environment.
`Environment`	`withFederationMode(FederationMode federationMode)` The authentication mode for the environment.
`Environment`	`withFederationMode(String federationMode)` The authentication mode for the environment.
`Environment`	`withFederationParameters(FederationParameters federationParameters)` Configuration information when authentication mode is FEDERATED.
`Environment`	`withKmsKeyId(String kmsKeyId)` The KMS key id used to encrypt in the FinSpace environment.
`Environment`	`withName(String name)` The name of the FinSpace environment.
`Environment`	`withSageMakerStudioDomainUrl(String sageMakerStudioDomainUrl)` The url of the integrated FinSpace notebook environment in your web application.
`Environment`	`withStatus(EnvironmentStatus status)` The current status of creation of the FinSpace environment.
`Environment`	`withStatus(String status)` The current status of creation of the FinSpace environment.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Environment
```
public Environment()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the FinSpace environment.
    
    Parameters:
    
    name - The name of the FinSpace environment.
  - getName
```
public String getName()
```
    The name of the FinSpace environment.
    
    Returns:
    
    The name of the FinSpace environment.
  - withName
```
public Environment withName(String name)
```
    The name of the FinSpace environment.
    
    Parameters:
    
    name - The name of the FinSpace environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnvironmentId
```
public void setEnvironmentId(String environmentId)
```
    The identifier of the FinSpace environment.
    
    Parameters:
    
    environmentId - The identifier of the FinSpace environment.
  - getEnvironmentId
```
public String getEnvironmentId()
```
    The identifier of the FinSpace environment.
    
    Returns:
    
    The identifier of the FinSpace environment.
  - withEnvironmentId
```
public Environment withEnvironmentId(String environmentId)
```
    The identifier of the FinSpace environment.
    
    Parameters:
    
    environmentId - The identifier of the FinSpace environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAwsAccountId
```
public void setAwsAccountId(String awsAccountId)
```
    The ID of the AWS account in which the FinSpace environment is created.
    
    Parameters:
    
    awsAccountId - The ID of the AWS account in which the FinSpace environment is created.
  - getAwsAccountId
```
public String getAwsAccountId()
```
    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.
  - withAwsAccountId
```
public Environment withAwsAccountId(String awsAccountId)
```
    The ID of the AWS account in which the FinSpace environment is created.
    
    Parameters:
    
    awsAccountId - The ID of the AWS account in which the FinSpace environment is created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current status of creation of the FinSpace environment.
    
    Parameters:
    
    status - The current status of creation of the FinSpace environment.
    
    See Also:
    
    EnvironmentStatus
  - getStatus
```
public String getStatus()
```
    The current status of creation of the FinSpace environment.
    
    Returns:
    
    The current status of creation of the FinSpace environment.
    
    See Also:
    
    EnvironmentStatus
  - withStatus
```
public Environment withStatus(String status)
```
    The current status of creation of the FinSpace environment.
    
    Parameters:
    
    status - The current status of creation of the FinSpace environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnvironmentStatus
  - withStatus
```
public Environment withStatus(EnvironmentStatus status)
```
    The current status of creation of the FinSpace environment.
    
    Parameters:
    
    status - The current status of creation of the FinSpace environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnvironmentStatus
  - setEnvironmentUrl
```
public void setEnvironmentUrl(String environmentUrl)
```
    The sign-in url for the web application of your FinSpace environment.
    
    Parameters:
    
    environmentUrl - The sign-in url for the web application of your FinSpace environment.
  - getEnvironmentUrl
```
public String getEnvironmentUrl()
```
    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.
  - withEnvironmentUrl
```
public Environment withEnvironmentUrl(String environmentUrl)
```
    The sign-in url for the web application of your FinSpace environment.
    
    Parameters:
    
    environmentUrl - The sign-in url for the web application of your FinSpace environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the FinSpace environment.
    
    Parameters:
    
    description - The description of the FinSpace environment.
  - getDescription
```
public String getDescription()
```
    The description of the FinSpace environment.
    
    Returns:
    
    The description of the FinSpace environment.
  - withDescription
```
public Environment withDescription(String description)
```
    The description of the FinSpace environment.
    
    Parameters:
    
    description - The description of the FinSpace environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnvironmentArn
```
public void setEnvironmentArn(String environmentArn)
```
    The Amazon Resource Name (ARN) of your FinSpace environment.
    
    Parameters:
    
    environmentArn - The Amazon Resource Name (ARN) of your FinSpace environment.
  - getEnvironmentArn
```
public String getEnvironmentArn()
```
    The Amazon Resource Name (ARN) of your FinSpace environment.
    
    Returns:
    
    The Amazon Resource Name (ARN) of your FinSpace environment.
  - withEnvironmentArn
```
public Environment withEnvironmentArn(String environmentArn)
```
    The Amazon Resource Name (ARN) of your FinSpace environment.
    
    Parameters:
    
    environmentArn - The Amazon Resource Name (ARN) of your FinSpace environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSageMakerStudioDomainUrl
```
public void setSageMakerStudioDomainUrl(String sageMakerStudioDomainUrl)
```
    The url of the integrated FinSpace notebook environment in your web application.
    
    Parameters:
    
    sageMakerStudioDomainUrl - The url of the integrated FinSpace notebook environment in your web application.
  - getSageMakerStudioDomainUrl
```
public String getSageMakerStudioDomainUrl()
```
    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.
  - withSageMakerStudioDomainUrl
```
public Environment withSageMakerStudioDomainUrl(String sageMakerStudioDomainUrl)
```
    The url of the integrated FinSpace notebook environment in your web application.
    
    Parameters:
    
    sageMakerStudioDomainUrl - The url of the integrated FinSpace notebook environment in your web application.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The KMS key id used to encrypt in the FinSpace environment.
    
    Parameters:
    
    kmsKeyId - The KMS key id used to encrypt in the FinSpace environment.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The KMS key id used to encrypt in the FinSpace environment.
    
    Returns:
    
    The KMS key id used to encrypt in the FinSpace environment.
  - withKmsKeyId
```
public Environment withKmsKeyId(String kmsKeyId)
```
    The KMS key id used to encrypt in the FinSpace environment.
    
    Parameters:
    
    kmsKeyId - The KMS key id used to encrypt in the FinSpace environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDedicatedServiceAccountId
```
public void setDedicatedServiceAccountId(String dedicatedServiceAccountId)
```
    The AWS account ID of the dedicated service account associated with your FinSpace environment.
    
    Parameters:
    
    dedicatedServiceAccountId - The AWS account ID of the dedicated service account associated with your FinSpace environment.
  - getDedicatedServiceAccountId
```
public String getDedicatedServiceAccountId()
```
    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.
  - withDedicatedServiceAccountId
```
public Environment withDedicatedServiceAccountId(String dedicatedServiceAccountId)
```
    The AWS account ID of the dedicated service account associated with your FinSpace environment.
    
    Parameters:
    
    dedicatedServiceAccountId - The AWS account ID of the dedicated service account associated with your FinSpace environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFederationMode
```
public void setFederationMode(String federationMode)
```
    The authentication mode for the environment.
    
    Parameters:
    
    federationMode - The authentication mode for the environment.
    
    See Also:
    
    FederationMode
  - getFederationMode
```
public String getFederationMode()
```
    The authentication mode for the environment.
    
    Returns:
    
    The authentication mode for the environment.
    
    See Also:
    
    FederationMode
  - withFederationMode
```
public Environment withFederationMode(String federationMode)
```
    The authentication mode for the environment.
    
    Parameters:
    
    federationMode - The authentication mode for the environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FederationMode
  - withFederationMode
```
public Environment withFederationMode(FederationMode federationMode)
```
    The authentication mode for the environment.
    
    Parameters:
    
    federationMode - The authentication mode for the environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FederationMode
  - setFederationParameters
```
public void setFederationParameters(FederationParameters federationParameters)
```
    Configuration information when authentication mode is FEDERATED.
    
    Parameters:
    
    federationParameters - Configuration information when authentication mode is FEDERATED.
  - getFederationParameters
```
public FederationParameters getFederationParameters()
```
    Configuration information when authentication mode is FEDERATED.
    
    Returns:
    
    Configuration information when authentication mode is FEDERATED.
  - withFederationParameters
```
public Environment withFederationParameters(FederationParameters federationParameters)
```
    Configuration information when authentication mode is FEDERATED.
    
    Parameters:
    
    federationParameters - Configuration information when authentication mode is FEDERATED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Environment clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Environment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Environment

Method Detail

setName

getName

withName

setEnvironmentId

getEnvironmentId

withEnvironmentId

setAwsAccountId

getAwsAccountId

withAwsAccountId

setStatus

getStatus

withStatus

withStatus

setEnvironmentUrl

getEnvironmentUrl

withEnvironmentUrl

setDescription

getDescription

withDescription

setEnvironmentArn

getEnvironmentArn

withEnvironmentArn

setSageMakerStudioDomainUrl

getSageMakerStudioDomainUrl

withSageMakerStudioDomainUrl

setKmsKeyId

getKmsKeyId

withKmsKeyId

setDedicatedServiceAccountId

getDedicatedServiceAccountId

withDedicatedServiceAccountId

setFederationMode

getFederationMode

withFederationMode

withFederationMode

setFederationParameters

getFederationParameters

withFederationParameters

toString

equals

hashCode

clone

marshall