1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateEnvironmentInput {
/// <p>The name of the FinSpace environment to be created.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>The description of the FinSpace environment to be created.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The KMS key id to encrypt your data in the FinSpace environment.</p>
pub kms_key_id: ::std::option::Option<::std::string::String>,
/// <p>Add tags to your FinSpace environment.</p>
pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <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>
pub federation_mode: ::std::option::Option<crate::types::FederationMode>,
/// <p>Configuration information when authentication mode is FEDERATED.</p>
pub federation_parameters: ::std::option::Option<crate::types::FederationParameters>,
/// <p>Configuration information for the superuser.</p>
pub superuser_parameters: ::std::option::Option<crate::types::SuperuserParameters>,
/// <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>
pub data_bundles: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
}
impl CreateEnvironmentInput {
/// <p>The name of the FinSpace environment to be created.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The description of the FinSpace environment to be created.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The KMS key id to encrypt your data in the FinSpace environment.</p>
pub fn kms_key_id(&self) -> ::std::option::Option<&str> {
self.kms_key_id.as_deref()
}
/// <p>Add tags to your FinSpace environment.</p>
pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.tags.as_ref()
}
/// <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>
pub fn federation_mode(&self) -> ::std::option::Option<&crate::types::FederationMode> {
self.federation_mode.as_ref()
}
/// <p>Configuration information when authentication mode is FEDERATED.</p>
pub fn federation_parameters(&self) -> ::std::option::Option<&crate::types::FederationParameters> {
self.federation_parameters.as_ref()
}
/// <p>Configuration information for the superuser.</p>
pub fn superuser_parameters(&self) -> ::std::option::Option<&crate::types::SuperuserParameters> {
self.superuser_parameters.as_ref()
}
/// <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>
///
/// 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()`.
pub fn data_bundles(&self) -> &[::std::string::String] {
self.data_bundles.as_deref().unwrap_or_default()
}
}
impl CreateEnvironmentInput {
/// Creates a new builder-style object to manufacture [`CreateEnvironmentInput`](crate::operation::create_environment::CreateEnvironmentInput).
pub fn builder() -> crate::operation::create_environment::builders::CreateEnvironmentInputBuilder {
crate::operation::create_environment::builders::CreateEnvironmentInputBuilder::default()
}
}
/// A builder for [`CreateEnvironmentInput`](crate::operation::create_environment::CreateEnvironmentInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct CreateEnvironmentInputBuilder {
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) kms_key_id: ::std::option::Option<::std::string::String>,
pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) federation_mode: ::std::option::Option<crate::types::FederationMode>,
pub(crate) federation_parameters: ::std::option::Option<crate::types::FederationParameters>,
pub(crate) superuser_parameters: ::std::option::Option<crate::types::SuperuserParameters>,
pub(crate) data_bundles: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
}
impl CreateEnvironmentInputBuilder {
/// <p>The name of the FinSpace environment to be created.</p>
/// This field is required.
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the FinSpace environment to be created.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name of the FinSpace environment to be created.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>The description of the FinSpace environment to be created.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>The description of the FinSpace environment to be created.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>The description of the FinSpace environment to be created.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The KMS key id to encrypt your data in the FinSpace environment.</p>
pub fn kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.kms_key_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The KMS key id to encrypt your data in the FinSpace environment.</p>
pub fn set_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.kms_key_id = input;
self
}
/// <p>The KMS key id to encrypt your data in the FinSpace environment.</p>
pub fn get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
&self.kms_key_id
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>Add tags to your FinSpace environment.</p>
pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut hash_map = self.tags.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.tags = ::std::option::Option::Some(hash_map);
self
}
/// <p>Add tags to your FinSpace environment.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
self.tags = input;
self
}
/// <p>Add tags to your FinSpace environment.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.tags
}
/// <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>
pub fn federation_mode(mut self, input: crate::types::FederationMode) -> Self {
self.federation_mode = ::std::option::Option::Some(input);
self
}
/// <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>
pub fn set_federation_mode(mut self, input: ::std::option::Option<crate::types::FederationMode>) -> Self {
self.federation_mode = input;
self
}
/// <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>
pub fn get_federation_mode(&self) -> &::std::option::Option<crate::types::FederationMode> {
&self.federation_mode
}
/// <p>Configuration information when authentication mode is FEDERATED.</p>
pub fn federation_parameters(mut self, input: crate::types::FederationParameters) -> Self {
self.federation_parameters = ::std::option::Option::Some(input);
self
}
/// <p>Configuration information when authentication mode is FEDERATED.</p>
pub fn set_federation_parameters(mut self, input: ::std::option::Option<crate::types::FederationParameters>) -> Self {
self.federation_parameters = input;
self
}
/// <p>Configuration information when authentication mode is FEDERATED.</p>
pub fn get_federation_parameters(&self) -> &::std::option::Option<crate::types::FederationParameters> {
&self.federation_parameters
}
/// <p>Configuration information for the superuser.</p>
pub fn superuser_parameters(mut self, input: crate::types::SuperuserParameters) -> Self {
self.superuser_parameters = ::std::option::Option::Some(input);
self
}
/// <p>Configuration information for the superuser.</p>
pub fn set_superuser_parameters(mut self, input: ::std::option::Option<crate::types::SuperuserParameters>) -> Self {
self.superuser_parameters = input;
self
}
/// <p>Configuration information for the superuser.</p>
pub fn get_superuser_parameters(&self) -> &::std::option::Option<crate::types::SuperuserParameters> {
&self.superuser_parameters
}
/// Appends an item to `data_bundles`.
///
/// To override the contents of this collection use [`set_data_bundles`](Self::set_data_bundles).
///
/// <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>
pub fn data_bundles(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.data_bundles.unwrap_or_default();
v.push(input.into());
self.data_bundles = ::std::option::Option::Some(v);
self
}
/// <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>
pub fn set_data_bundles(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.data_bundles = input;
self
}
/// <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>
pub fn get_data_bundles(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.data_bundles
}
/// Consumes the builder and constructs a [`CreateEnvironmentInput`](crate::operation::create_environment::CreateEnvironmentInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_environment::CreateEnvironmentInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_environment::CreateEnvironmentInput {
name: self.name,
description: self.description,
kms_key_id: self.kms_key_id,
tags: self.tags,
federation_mode: self.federation_mode,
federation_parameters: self.federation_parameters,
superuser_parameters: self.superuser_parameters,
data_bundles: self.data_bundles,
})
}
}