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.CreateEnvironment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create a new FinSpace environment.

Synopsis

data CreateEnvironment = CreateEnvironment' {
- federationParameters :: Maybe FederationParameters
- federationMode :: Maybe FederationMode
- kmsKeyId :: Maybe Text
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- name :: Text
}
newCreateEnvironment :: Text -> CreateEnvironment
createEnvironment_federationParameters :: Lens' CreateEnvironment (Maybe FederationParameters)
createEnvironment_federationMode :: Lens' CreateEnvironment (Maybe FederationMode)
createEnvironment_kmsKeyId :: Lens' CreateEnvironment (Maybe Text)
createEnvironment_description :: Lens' CreateEnvironment (Maybe Text)
createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text))
createEnvironment_name :: Lens' CreateEnvironment Text
data CreateEnvironmentResponse = CreateEnvironmentResponse' {
- environmentUrl :: Maybe Text
- environmentId :: Maybe Text
- environmentArn :: Maybe Text
- httpStatus :: Int
}
newCreateEnvironmentResponse :: Int -> CreateEnvironmentResponse
createEnvironmentResponse_environmentUrl :: Lens' CreateEnvironmentResponse (Maybe Text)
createEnvironmentResponse_environmentId :: Lens' CreateEnvironmentResponse (Maybe Text)
createEnvironmentResponse_environmentArn :: Lens' CreateEnvironmentResponse (Maybe Text)
createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int

Creating a Request

data CreateEnvironment Source #

See: newCreateEnvironment smart constructor.

Constructors

CreateEnvironment'

Fields

federationParameters :: Maybe FederationParameters
Configuration information when authentication mode is FEDERATED.
federationMode :: Maybe FederationMode
Authentication mode for the environment.
- FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
- LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
kmsKeyId :: Maybe Text
The KMS key id to encrypt your data in the FinSpace environment.
description :: Maybe Text
The description of the FinSpace environment to be created.
tags :: Maybe (HashMap Text Text)
Add tags to your FinSpace environment.
name :: Text
The name of the FinSpace environment to be created.

Instances

Instances details

Eq CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods (==) :: CreateEnvironment -> CreateEnvironment -> Bool # (/=) :: CreateEnvironment -> CreateEnvironment -> Bool #
Read CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods readsPrec :: Int -> ReadS CreateEnvironment # readList :: ReadS [CreateEnvironment] # readPrec :: ReadPrec CreateEnvironment # readListPrec :: ReadPrec [CreateEnvironment] #
Show CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods showsPrec :: Int -> CreateEnvironment -> ShowS # show :: CreateEnvironment -> String # showList :: [CreateEnvironment] -> ShowS #
Generic CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Associated Types type Rep CreateEnvironment :: Type -> Type # Methods from :: CreateEnvironment -> Rep CreateEnvironment x # to :: Rep CreateEnvironment x -> CreateEnvironment #
NFData CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods rnf :: CreateEnvironment -> () #
Hashable CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods hashWithSalt :: Int -> CreateEnvironment -> Int # hash :: CreateEnvironment -> Int #
ToJSON CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods toJSON :: CreateEnvironment -> Value # toEncoding :: CreateEnvironment -> Encoding # toJSONList :: [CreateEnvironment] -> Value # toEncodingList :: [CreateEnvironment] -> Encoding #
AWSRequest CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Associated Types type AWSResponse CreateEnvironment # Methods request :: CreateEnvironment -> Request CreateEnvironment # response :: MonadResource m => Logger -> Service -> Proxy CreateEnvironment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEnvironment))) #
ToHeaders CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods toHeaders :: CreateEnvironment -> [Header] #
ToPath CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods toPath :: CreateEnvironment -> ByteString #
ToQuery CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods toQuery :: CreateEnvironment -> QueryString #
type Rep CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment type Rep CreateEnvironment = D1 ('MetaData "CreateEnvironment" "Amazonka.FinSpace.CreateEnvironment" "libZSservicesZSamazonka-finspaceZSamazonka-finspace" 'False) (C1 ('MetaCons "CreateEnvironment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "federationParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FederationParameters)) :: (S1 ('MetaSel ('Just "federationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FederationMode)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment type AWSResponse CreateEnvironment = CreateEnvironmentResponse

newCreateEnvironment Source #

Arguments

:: Text	`$sel:name:CreateEnvironment'`
-> CreateEnvironment

Create a value of CreateEnvironment 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:federationParameters:CreateEnvironment', createEnvironment_federationParameters - Configuration information when authentication mode is FEDERATED.

$sel:federationMode:CreateEnvironment', createEnvironment_federationMode - Authentication mode for the environment.

FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

$sel:kmsKeyId:CreateEnvironment', createEnvironment_kmsKeyId - The KMS key id to encrypt your data in the FinSpace environment.

$sel:description:CreateEnvironment', createEnvironment_description - The description of the FinSpace environment to be created.

$sel:tags:CreateEnvironment', createEnvironment_tags - Add tags to your FinSpace environment.

$sel:name:CreateEnvironment', createEnvironment_name - The name of the FinSpace environment to be created.

Request Lenses

createEnvironment_federationParameters :: Lens' CreateEnvironment (Maybe FederationParameters) Source #

Configuration information when authentication mode is FEDERATED.

createEnvironment_federationMode :: Lens' CreateEnvironment (Maybe FederationMode) Source #

Authentication mode for the environment.

FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

createEnvironment_kmsKeyId :: Lens' CreateEnvironment (Maybe Text) Source #

The KMS key id to encrypt your data in the FinSpace environment.

createEnvironment_description :: Lens' CreateEnvironment (Maybe Text) Source #

The description of the FinSpace environment to be created.

createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text)) Source #

Add tags to your FinSpace environment.

createEnvironment_name :: Lens' CreateEnvironment Text Source #

The name of the FinSpace environment to be created.

Destructuring the Response

data CreateEnvironmentResponse Source #

See: newCreateEnvironmentResponse smart constructor.

Constructors

CreateEnvironmentResponse'
Fields environmentUrl :: Maybe Text The sign-in url for the web application of the FinSpace environment you created. environmentId :: Maybe Text The unique identifier for FinSpace environment that you created. environmentArn :: Maybe Text The Amazon Resource Name (ARN) of the FinSpace environment that you created. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods (==) :: CreateEnvironmentResponse -> CreateEnvironmentResponse -> Bool # (/=) :: CreateEnvironmentResponse -> CreateEnvironmentResponse -> Bool #
Read CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods readsPrec :: Int -> ReadS CreateEnvironmentResponse # readList :: ReadS [CreateEnvironmentResponse] # readPrec :: ReadPrec CreateEnvironmentResponse # readListPrec :: ReadPrec [CreateEnvironmentResponse] #
Show CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods showsPrec :: Int -> CreateEnvironmentResponse -> ShowS # show :: CreateEnvironmentResponse -> String # showList :: [CreateEnvironmentResponse] -> ShowS #
Generic CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Associated Types type Rep CreateEnvironmentResponse :: Type -> Type # Methods from :: CreateEnvironmentResponse -> Rep CreateEnvironmentResponse x # to :: Rep CreateEnvironmentResponse x -> CreateEnvironmentResponse #
NFData CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment Methods rnf :: CreateEnvironmentResponse -> () #
type Rep CreateEnvironmentResponse Source #
Instance details Defined in Amazonka.FinSpace.CreateEnvironment type Rep CreateEnvironmentResponse = D1 ('MetaData "CreateEnvironmentResponse" "Amazonka.FinSpace.CreateEnvironment" "libZSservicesZSamazonka-finspaceZSamazonka-finspace" 'False) (C1 ('MetaCons "CreateEnvironmentResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "environmentUrl") '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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateEnvironmentResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEnvironmentResponse'`
-> CreateEnvironmentResponse

Create a value of CreateEnvironmentResponse 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:environmentUrl:CreateEnvironmentResponse', createEnvironmentResponse_environmentUrl - The sign-in url for the web application of the FinSpace environment you created.

$sel:environmentId:CreateEnvironmentResponse', createEnvironmentResponse_environmentId - The unique identifier for FinSpace environment that you created.

$sel:environmentArn:CreateEnvironmentResponse', createEnvironmentResponse_environmentArn - The Amazon Resource Name (ARN) of the FinSpace environment that you created.

$sel:httpStatus:CreateEnvironmentResponse', createEnvironmentResponse_httpStatus - The response's http status code.

Response Lenses

createEnvironmentResponse_environmentUrl :: Lens' CreateEnvironmentResponse (Maybe Text) Source #

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

createEnvironmentResponse_environmentId :: Lens' CreateEnvironmentResponse (Maybe Text) Source #

The unique identifier for FinSpace environment that you created.

createEnvironmentResponse_environmentArn :: Lens' CreateEnvironmentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the FinSpace environment that you created.

createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int Source #

The response's http status code.