aws_sdk_finspace/client/
create_environment.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateEnvironment`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_name):<br>required: **true**<br><p>The name of the FinSpace environment to be created.</p><br>
7    ///   - [`description(impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_description):<br>required: **false**<br><p>The description of the FinSpace environment to be created.</p><br>
8    ///   - [`kms_key_id(impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::kms_key_id) / [`set_kms_key_id(Option<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_kms_key_id):<br>required: **false**<br><p>The KMS key id to encrypt your data in the FinSpace environment.</p><br>
9    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_tags):<br>required: **false**<br><p>Add tags to your FinSpace environment.</p><br>
10    ///   - [`federation_mode(FederationMode)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::federation_mode) / [`set_federation_mode(Option<FederationMode>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_federation_mode):<br>required: **false**<br><p>Authentication mode for the environment.</p> <ul>  <li>   <p><code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your Identity provider.</p></li>  <li>   <p><code>LOCAL</code> - Users access FinSpace via email and password managed within the FinSpace environment.</p></li> </ul><br>
11    ///   - [`federation_parameters(FederationParameters)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::federation_parameters) / [`set_federation_parameters(Option<FederationParameters>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_federation_parameters):<br>required: **false**<br><p>Configuration information when authentication mode is FEDERATED.</p><br>
12    ///   - [`superuser_parameters(SuperuserParameters)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::superuser_parameters) / [`set_superuser_parameters(Option<SuperuserParameters>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_superuser_parameters):<br>required: **false**<br><p>Configuration information for the superuser.</p><br>
13    ///   - [`data_bundles(impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::data_bundles) / [`set_data_bundles(Option<Vec::<String>>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_data_bundles):<br>required: **false**<br><p>The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:</p> <ul>  <li>   <p><code>arn:aws:finspace:${Region}::data-bundle/capital-markets-sample</code> - Contains sample Capital Markets datasets, categories and controlled vocabularies.</p></li>  <li>   <p><code>arn:aws:finspace:${Region}::data-bundle/taq</code> (default) - Contains trades and quotes data in addition to sample Capital Markets data.</p></li> </ul><br>
14    /// - On success, responds with [`CreateEnvironmentOutput`](crate::operation::create_environment::CreateEnvironmentOutput) with field(s):
15    ///   - [`environment_id(Option<String>)`](crate::operation::create_environment::CreateEnvironmentOutput::environment_id): <p>The unique identifier for FinSpace environment that you created.</p>
16    ///   - [`environment_arn(Option<String>)`](crate::operation::create_environment::CreateEnvironmentOutput::environment_arn): <p>The Amazon Resource Name (ARN) of the FinSpace environment that you created.</p>
17    ///   - [`environment_url(Option<String>)`](crate::operation::create_environment::CreateEnvironmentOutput::environment_url): <p>The sign-in URL for the web application of the FinSpace environment you created.</p>
18    /// - On failure, responds with [`SdkError<CreateEnvironmentError>`](crate::operation::create_environment::CreateEnvironmentError)
19    #[deprecated(note = "This method will be discontinued.")]
20    pub fn create_environment(&self) -> crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder {
21        crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_finspace/client/create_environment.rs

aws_sdk_finspace/client/
create_environment.rs
