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
// 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 UpdateEnvironmentInput {
/// <p>The identifier of the FinSpace environment.</p>
pub environment_id: ::std::option::Option<::std::string::String>,
/// <p>The name of the environment.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>The description of the environment.</p>
pub description: ::std::option::Option<::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>,
}
impl UpdateEnvironmentInput {
/// <p>The identifier of the FinSpace environment.</p>
pub fn environment_id(&self) -> ::std::option::Option<&str> {
self.environment_id.as_deref()
}
/// <p>The name of the environment.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The description of the environment.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <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()
}
}
impl UpdateEnvironmentInput {
/// Creates a new builder-style object to manufacture [`UpdateEnvironmentInput`](crate::operation::update_environment::UpdateEnvironmentInput).
pub fn builder() -> crate::operation::update_environment::builders::UpdateEnvironmentInputBuilder {
crate::operation::update_environment::builders::UpdateEnvironmentInputBuilder::default()
}
}
/// A builder for [`UpdateEnvironmentInput`](crate::operation::update_environment::UpdateEnvironmentInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct UpdateEnvironmentInputBuilder {
pub(crate) environment_id: ::std::option::Option<::std::string::String>,
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) federation_mode: ::std::option::Option<crate::types::FederationMode>,
pub(crate) federation_parameters: ::std::option::Option<crate::types::FederationParameters>,
}
impl UpdateEnvironmentInputBuilder {
/// <p>The identifier of the FinSpace environment.</p>
/// This field is required.
pub fn environment_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.environment_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of the FinSpace environment.</p>
pub fn set_environment_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.environment_id = input;
self
}
/// <p>The identifier of the FinSpace environment.</p>
pub fn get_environment_id(&self) -> &::std::option::Option<::std::string::String> {
&self.environment_id
}
/// <p>The name of the environment.</p>
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 environment.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name of the environment.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>The description of the environment.</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 environment.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>The description of the environment.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <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
}
/// Consumes the builder and constructs a [`UpdateEnvironmentInput`](crate::operation::update_environment::UpdateEnvironmentInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::update_environment::UpdateEnvironmentInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::update_environment::UpdateEnvironmentInput {
environment_id: self.environment_id,
name: self.name,
description: self.description,
federation_mode: self.federation_mode,
federation_parameters: self.federation_parameters,
})
}
}