Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Create a new FinSpace environment.
Synopsis
- data CreateEnvironment = CreateEnvironment' {}
- newCreateEnvironment :: Text -> CreateEnvironment
- createEnvironment_dataBundles :: Lens' CreateEnvironment (Maybe [Text])
- createEnvironment_description :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_federationMode :: Lens' CreateEnvironment (Maybe FederationMode)
- createEnvironment_federationParameters :: Lens' CreateEnvironment (Maybe FederationParameters)
- createEnvironment_kmsKeyId :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_superuserParameters :: Lens' CreateEnvironment (Maybe SuperuserParameters)
- createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text))
- createEnvironment_name :: Lens' CreateEnvironment Text
- data CreateEnvironmentResponse = CreateEnvironmentResponse' {}
- newCreateEnvironmentResponse :: Int -> CreateEnvironmentResponse
- createEnvironmentResponse_environmentArn :: Lens' CreateEnvironmentResponse (Maybe Text)
- createEnvironmentResponse_environmentId :: Lens' CreateEnvironmentResponse (Maybe Text)
- createEnvironmentResponse_environmentUrl :: Lens' CreateEnvironmentResponse (Maybe Text)
- createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int
Creating a Request
data CreateEnvironment Source #
See: newCreateEnvironment
smart constructor.
CreateEnvironment' | |
|
Instances
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_superuserParameters :: Lens' CreateEnvironment (Maybe SuperuserParameters) Source #
Configuration information for the superuser.
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.
CreateEnvironmentResponse' | |
|
Instances
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.
createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int Source #
The response's http status code.