Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.FinSpace.Types.Environment

Description

Synopsis

data Environment = Environment' {
- status :: Maybe EnvironmentStatus
- federationParameters :: Maybe FederationParameters
- dedicatedServiceAccountId :: Maybe Text
- environmentUrl :: Maybe Text
- federationMode :: Maybe FederationMode
- awsAccountId :: Maybe Text
- name :: Maybe Text
- kmsKeyId :: Maybe Text
- environmentId :: Maybe Text
- environmentArn :: Maybe Text
- sageMakerStudioDomainUrl :: Maybe Text
- description :: Maybe Text
}
newEnvironment :: Environment
environment_status :: Lens' Environment (Maybe EnvironmentStatus)
environment_federationParameters :: Lens' Environment (Maybe FederationParameters)
environment_dedicatedServiceAccountId :: Lens' Environment (Maybe Text)
environment_environmentUrl :: Lens' Environment (Maybe Text)
environment_federationMode :: Lens' Environment (Maybe FederationMode)
environment_awsAccountId :: Lens' Environment (Maybe Text)
environment_name :: Lens' Environment (Maybe Text)
environment_kmsKeyId :: Lens' Environment (Maybe Text)
environment_environmentId :: Lens' Environment (Maybe Text)
environment_environmentArn :: Lens' Environment (Maybe Text)
environment_sageMakerStudioDomainUrl :: Lens' Environment (Maybe Text)
environment_description :: Lens' Environment (Maybe Text)

Documentation

data Environment Source #

Represents an FinSpace environment.

See: newEnvironment smart constructor.

Constructors

Environment'

Fields

status :: Maybe EnvironmentStatus
The current status of creation of the FinSpace environment.
federationParameters :: Maybe FederationParameters
Configuration information when authentication mode is FEDERATED.
dedicatedServiceAccountId :: Maybe Text
The AWS account ID of the dedicated service account associated with your FinSpace environment.
environmentUrl :: Maybe Text
The sign-in url for the web application of your FinSpace environment.
federationMode :: Maybe FederationMode
The authentication mode for the environment.
awsAccountId :: Maybe Text
The ID of the AWS account in which the FinSpace environment is created.
name :: Maybe Text
The name of the FinSpace environment.
kmsKeyId :: Maybe Text
The KMS key id used to encrypt in the FinSpace environment.
environmentId :: Maybe Text
The identifier of the FinSpace environment.
environmentArn :: Maybe Text
The Amazon Resource Name (ARN) of your FinSpace environment.
sageMakerStudioDomainUrl :: Maybe Text
The url of the integrated FinSpace notebook environment in your web application.
description :: Maybe Text
The description of the FinSpace environment.

Instances

Instances details

Eq Environment Source #
Instance details Defined in Amazonka.FinSpace.Types.Environment Methods (==) :: Environment -> Environment -> Bool # (/=) :: Environment -> Environment -> Bool #
Read Environment Source #
Instance details Defined in Amazonka.FinSpace.Types.Environment Methods readsPrec :: Int -> ReadS Environment # readList :: ReadS [Environment] # readPrec :: ReadPrec Environment # readListPrec :: ReadPrec [Environment] #
Show Environment Source #
Instance details Defined in Amazonka.FinSpace.Types.Environment Methods showsPrec :: Int -> Environment -> ShowS # show :: Environment -> String # showList :: [Environment] -> ShowS #
Generic Environment Source #
Instance details Defined in Amazonka.FinSpace.Types.Environment Associated Types type Rep Environment :: Type -> Type # Methods from :: Environment -> Rep Environment x # to :: Rep Environment x -> Environment #
NFData Environment Source #
Instance details Defined in Amazonka.FinSpace.Types.Environment Methods rnf :: Environment -> () #
Hashable Environment Source #
Instance details Defined in Amazonka.FinSpace.Types.Environment Methods hashWithSalt :: Int -> Environment -> Int # hash :: Environment -> Int #
FromJSON Environment Source #
Instance details Defined in Amazonka.FinSpace.Types.Environment Methods parseJSON :: Value -> Parser Environment # parseJSONList :: Value -> Parser [Environment] #
type Rep Environment Source #
Instance details Defined in Amazonka.FinSpace.Types.Environment type Rep Environment = D1 ('MetaData "Environment" "Amazonka.FinSpace.Types.Environment" "libZSservicesZSamazonka-finspaceZSamazonka-finspace" 'False) (C1 ('MetaCons "Environment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentStatus)) :: (S1 ('MetaSel ('Just "federationParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FederationParameters)) :: S1 ('MetaSel ('Just "dedicatedServiceAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "environmentUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "federationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FederationMode)) :: S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "environmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sageMakerStudioDomainUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newEnvironment :: Environment Source #

Create a value of Environment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:Environment', environment_status - The current status of creation of the FinSpace environment.

$sel:federationParameters:Environment', environment_federationParameters - Configuration information when authentication mode is FEDERATED.

$sel:dedicatedServiceAccountId:Environment', environment_dedicatedServiceAccountId - The AWS account ID of the dedicated service account associated with your FinSpace environment.

$sel:environmentUrl:Environment', environment_environmentUrl - The sign-in url for the web application of your FinSpace environment.

$sel:federationMode:Environment', environment_federationMode - The authentication mode for the environment.

$sel:awsAccountId:Environment', environment_awsAccountId - The ID of the AWS account in which the FinSpace environment is created.

$sel:name:Environment', environment_name - The name of the FinSpace environment.

$sel:kmsKeyId:Environment', environment_kmsKeyId - The KMS key id used to encrypt in the FinSpace environment.

$sel:environmentId:Environment', environment_environmentId - The identifier of the FinSpace environment.

$sel:environmentArn:Environment', environment_environmentArn - The Amazon Resource Name (ARN) of your FinSpace environment.

$sel:sageMakerStudioDomainUrl:Environment', environment_sageMakerStudioDomainUrl - The url of the integrated FinSpace notebook environment in your web application.

$sel:description:Environment', environment_description - The description of the FinSpace environment.

environment_status :: Lens' Environment (Maybe EnvironmentStatus) Source #

The current status of creation of the FinSpace environment.

environment_federationParameters :: Lens' Environment (Maybe FederationParameters) Source #

Configuration information when authentication mode is FEDERATED.

environment_dedicatedServiceAccountId :: Lens' Environment (Maybe Text) Source #

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

environment_environmentUrl :: Lens' Environment (Maybe Text) Source #

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

environment_federationMode :: Lens' Environment (Maybe FederationMode) Source #

The authentication mode for the environment.

environment_awsAccountId :: Lens' Environment (Maybe Text) Source #

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

environment_name :: Lens' Environment (Maybe Text) Source #

The name of the FinSpace environment.

environment_kmsKeyId :: Lens' Environment (Maybe Text) Source #

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

environment_environmentId :: Lens' Environment (Maybe Text) Source #

The identifier of the FinSpace environment.

environment_environmentArn :: Lens' Environment (Maybe Text) Source #

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

environment_sageMakerStudioDomainUrl :: Lens' Environment (Maybe Text) Source #

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

environment_description :: Lens' Environment (Maybe Text) Source #

The description of the FinSpace environment.