Struct aws_sdk_finspace::client::fluent_builders::CreateEnvironment

pub struct CreateEnvironment { /* private fields */ }

Fluent builder constructing a request to CreateEnvironment.

Create a new FinSpace environment.

Implementations

impl CreateEnvironment

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateEnvironment, AwsResponseRetryClassifier>, SdkError<CreateEnvironmentError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateEnvironmentOutput, SdkError<CreateEnvironmentError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

The name of the FinSpace environment to be created.

pub fn set_name(self, input: Option<String>) -> Self

The name of the FinSpace environment to be created.

pub fn description(self, input: impl Into<String>) -> Self

The description of the FinSpace environment to be created.

pub fn set_description(self, input: Option<String>) -> Self

The description of the FinSpace environment to be created.

pub fn kms_key_id(self, input: impl Into<String>) -> Self

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

pub fn set_kms_key_id(self, input: Option<String>) -> Self

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

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

Add tags to your FinSpace environment.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

Add tags to your FinSpace environment.

pub fn federation_mode(self, input: FederationMode) -> Self

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.

pub fn set_federation_mode(self, input: Option<FederationMode>) -> Self

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.

pub fn federation_parameters(self, input: FederationParameters) -> Self

Configuration information when authentication mode is FEDERATED.

pub fn set_federation_parameters(
    self,
    input: Option<FederationParameters>
) -> Self

Configuration information when authentication mode is FEDERATED.

pub fn superuser_parameters(self, input: SuperuserParameters) -> Self

Configuration information for the superuser.

pub fn set_superuser_parameters(self, input: Option<SuperuserParameters>) -> Self

Configuration information for the superuser.

pub fn data_bundles(self, input: impl Into<String>) -> Self

Appends an item to dataBundles.

To override the contents of this collection use set_data_bundles.

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.

pub fn set_data_bundles(self, input: Option<Vec<String>>) -> Self

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.

Trait Implementations

impl Clone for CreateEnvironment

fn clone(&self) -> CreateEnvironment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateEnvironment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.