amazonka-finspace-2.0: Amazon FinSpace User Environment Management service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FinSpace.CreateEnvironment

Description

Create a new FinSpace environment.

Synopsis

Creating a Request

data CreateEnvironment Source #

See: newCreateEnvironment smart constructor.

Constructors

CreateEnvironment' 

Fields

  • dataBundles :: Maybe [Text]

    The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

    • arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
    • arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
  • description :: Maybe Text

    The description of the FinSpace environment to be created.

  • 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.
  • federationParameters :: Maybe FederationParameters

    Configuration information when authentication mode is FEDERATED.

  • kmsKeyId :: Maybe Text

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

  • superuserParameters :: Maybe SuperuserParameters

    Configuration information for the superuser.

  • 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
ToJSON CreateEnvironment Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

ToHeaders CreateEnvironment Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

ToPath CreateEnvironment Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

ToQuery CreateEnvironment Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

AWSRequest CreateEnvironment Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

Associated Types

type AWSResponse CreateEnvironment #

Generic CreateEnvironment Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

Associated Types

type Rep CreateEnvironment :: Type -> Type #

Show CreateEnvironment Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

NFData CreateEnvironment Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

Methods

rnf :: CreateEnvironment -> () #

Eq CreateEnvironment Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

Hashable CreateEnvironment Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

type AWSResponse CreateEnvironment Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

type Rep CreateEnvironment Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

newCreateEnvironment Source #

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:dataBundles:CreateEnvironment', createEnvironment_dataBundles - The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

  • arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
  • arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

CreateEnvironment, createEnvironment_description - The description of the FinSpace environment to be created.

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.

CreateEnvironment, createEnvironment_federationParameters - Configuration information when authentication mode is FEDERATED.

CreateEnvironment, createEnvironment_kmsKeyId - The KMS key id to encrypt your data in the FinSpace environment.

$sel:superuserParameters:CreateEnvironment', createEnvironment_superuserParameters - Configuration information for the superuser.

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

CreateEnvironment, createEnvironment_name - The name of the FinSpace environment to be created.

Request Lenses

createEnvironment_dataBundles :: Lens' CreateEnvironment (Maybe [Text]) Source #

The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

  • arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
  • arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

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

The description of the FinSpace environment to be created.

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_federationParameters :: Lens' CreateEnvironment (Maybe FederationParameters) Source #

Configuration information when authentication mode is FEDERATED.

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

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

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

Instances

Instances details
Generic CreateEnvironmentResponse Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

Associated Types

type Rep CreateEnvironmentResponse :: Type -> Type #

Read CreateEnvironmentResponse Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

Show CreateEnvironmentResponse Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

NFData CreateEnvironmentResponse Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

Eq CreateEnvironmentResponse Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

type Rep CreateEnvironmentResponse Source # 
Instance details

Defined in Amazonka.FinSpace.CreateEnvironment

type Rep CreateEnvironmentResponse = D1 ('MetaData "CreateEnvironmentResponse" "Amazonka.FinSpace.CreateEnvironment" "amazonka-finspace-2.0-D97KpJfy3e64ziV32Jkivv" 'False) (C1 ('MetaCons "CreateEnvironmentResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "environmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "environmentUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateEnvironmentResponse Source #

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:

CreateEnvironmentResponse, createEnvironmentResponse_environmentArn - The Amazon Resource Name (ARN) of the FinSpace environment that you created.

CreateEnvironmentResponse, createEnvironmentResponse_environmentId - The unique identifier for FinSpace environment that you created.

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

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

Response Lenses

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

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

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

The unique identifier for FinSpace environment that you created.

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

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