Struct aws_sdk_finspace::operation::create_environment::CreateEnvironmentInput

#[non_exhaustive]
pub struct CreateEnvironmentInput {
    pub name: Option<String>,
    pub description: Option<String>,
    pub kms_key_id: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub federation_mode: Option<FederationMode>,
    pub federation_parameters: Option<FederationParameters>,
    pub superuser_parameters: Option<SuperuserParameters>,
    pub data_bundles: Option<Vec<String>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the FinSpace environment to be created.

description: Option<String>

The description of the FinSpace environment to be created.

kms_key_id: Option<String>

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

tags: Option<HashMap<String, String>>

Add tags to your FinSpace environment.

federation_mode: Option<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.

federation_parameters: Option<FederationParameters>

Configuration information when authentication mode is FEDERATED.

superuser_parameters: Option<SuperuserParameters>

Configuration information for the superuser.

data_bundles: Option<Vec<String>>

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.

Implementations

impl CreateEnvironmentInput

pub fn name(&self) -> Option<&str>

The name of the FinSpace environment to be created.

pub fn description(&self) -> Option<&str>

The description of the FinSpace environment to be created.

pub fn kms_key_id(&self) -> Option<&str>

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

pub fn tags(&self) -> Option<&HashMap<String, String>>

Add tags to your FinSpace environment.

pub fn federation_mode(&self) -> Option<&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.

pub fn federation_parameters(&self) -> Option<&FederationParameters>

Configuration information when authentication mode is FEDERATED.

pub fn superuser_parameters(&self) -> Option<&SuperuserParameters>

Configuration information for the superuser.

pub fn data_bundles(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .data_bundles.is_none().

impl CreateEnvironmentInput

pub fn builder() -> CreateEnvironmentInputBuilder

Creates a new builder-style object to manufacture CreateEnvironmentInput.

Trait Implementations

impl Clone for CreateEnvironmentInput

fn clone(&self) -> CreateEnvironmentInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEnvironmentInput

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

Formats the value using the given formatter.

impl PartialEq for CreateEnvironmentInput

fn eq(&self, other: &CreateEnvironmentInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateEnvironmentInput