aws_sdk_transfer/client/
create_web_app.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 [`CreateWebApp`](crate::operation::create_web_app::builders::CreateWebAppFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`identity_provider_details(WebAppIdentityProviderDetails)`](crate::operation::create_web_app::builders::CreateWebAppFluentBuilder::identity_provider_details) / [`set_identity_provider_details(Option<WebAppIdentityProviderDetails>)`](crate::operation::create_web_app::builders::CreateWebAppFluentBuilder::set_identity_provider_details):<br>required: **true**<br><p>You can provide a structure that contains the details for the identity provider to use with your web app.</p> <p>For more details about this parameter, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/webapp-identity-center.html">Configure your identity provider for Transfer Family web apps</a>.</p><br>
7    ///   - [`access_endpoint(impl Into<String>)`](crate::operation::create_web_app::builders::CreateWebAppFluentBuilder::access_endpoint) / [`set_access_endpoint(Option<String>)`](crate::operation::create_web_app::builders::CreateWebAppFluentBuilder::set_access_endpoint):<br>required: **false**<br><p>The <code>AccessEndpoint</code> is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.</p> <p>Before you enter a custom URL for this parameter, follow the steps described in <a href="https://docs.aws.amazon.com/transfer/latest/userguide/webapp-customize.html">Update your access endpoint with a custom URL</a>.</p><br>
8    ///   - [`web_app_units(WebAppUnits)`](crate::operation::create_web_app::builders::CreateWebAppFluentBuilder::web_app_units) / [`set_web_app_units(Option<WebAppUnits>)`](crate::operation::create_web_app::builders::CreateWebAppFluentBuilder::set_web_app_units):<br>required: **false**<br><p>A union that contains the value for number of concurrent connections or the user sessions on your web app.</p><br>
9    ///   - [`tags(Tag)`](crate::operation::create_web_app::builders::CreateWebAppFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_web_app::builders::CreateWebAppFluentBuilder::set_tags):<br>required: **false**<br><p>Key-value pairs that can be used to group and search for web apps.</p><br>
10    ///   - [`web_app_endpoint_policy(WebAppEndpointPolicy)`](crate::operation::create_web_app::builders::CreateWebAppFluentBuilder::web_app_endpoint_policy) / [`set_web_app_endpoint_policy(Option<WebAppEndpointPolicy>)`](crate::operation::create_web_app::builders::CreateWebAppFluentBuilder::set_web_app_endpoint_policy):<br>required: **false**<br><p>Setting for the type of endpoint policy for the web app. The default value is <code>STANDARD</code>.</p> <p>If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to <code>FIPS</code>.</p><br>
11    /// - On success, responds with [`CreateWebAppOutput`](crate::operation::create_web_app::CreateWebAppOutput) with field(s):
12    ///   - [`web_app_id(String)`](crate::operation::create_web_app::CreateWebAppOutput::web_app_id): <p>Returns a unique identifier for the web app.</p>
13    /// - On failure, responds with [`SdkError<CreateWebAppError>`](crate::operation::create_web_app::CreateWebAppError)
14    pub fn create_web_app(&self) -> crate::operation::create_web_app::builders::CreateWebAppFluentBuilder {
15        crate::operation::create_web_app::builders::CreateWebAppFluentBuilder::new(self.handle.clone())
16    }
17}