aws_sdk_apigatewayv2/client/
create_portal.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 [`CreatePortal`](crate::operation::create_portal::builders::CreatePortalFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`authorization(Authorization)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::authorization) / [`set_authorization(Option<Authorization>)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::set_authorization):<br>required: **true**<br><p>The authentication configuration for the portal.</p><br>
7    ///   - [`endpoint_configuration(EndpointConfigurationRequest)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::endpoint_configuration) / [`set_endpoint_configuration(Option<EndpointConfigurationRequest>)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::set_endpoint_configuration):<br>required: **true**<br><p>The domain configuration for the portal. Use a default domain provided by API Gateway or provide a fully-qualified domain name that you own.</p><br>
8    ///   - [`included_portal_product_arns(impl Into<String>)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::included_portal_product_arns) / [`set_included_portal_product_arns(Option<Vec::<String>>)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::set_included_portal_product_arns):<br>required: **false**<br><p>The ARNs of the portal products included in the portal.</p><br>
9    ///   - [`logo_uri(impl Into<String>)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::logo_uri) / [`set_logo_uri(Option<String>)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::set_logo_uri):<br>required: **false**<br><p>The URI for the portal logo image that is displayed in the portal header.</p><br>
10    ///   - [`portal_content(PortalContent)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::portal_content) / [`set_portal_content(Option<PortalContent>)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::set_portal_content):<br>required: **true**<br><p>The content of the portal.</p><br>
11    ///   - [`rum_app_monitor_name(impl Into<String>)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::rum_app_monitor_name) / [`set_rum_app_monitor_name(Option<String>)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::set_rum_app_monitor_name):<br>required: **false**<br><p>The name of the Amazon CloudWatch RUM app monitor for the portal.</p><br>
12    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_portal::builders::CreatePortalFluentBuilder::set_tags):<br>required: **false**<br><p>The collection of tags. Each tag element is associated with a given resource.</p><br>
13    /// - On success, responds with [`CreatePortalOutput`](crate::operation::create_portal::CreatePortalOutput) with field(s):
14    ///   - [`authorization(Option<Authorization>)`](crate::operation::create_portal::CreatePortalOutput::authorization): <p>The authorization for the portal. Supports Cognito-based user authentication or no authentication.</p>
15    ///   - [`endpoint_configuration(Option<EndpointConfigurationResponse>)`](crate::operation::create_portal::CreatePortalOutput::endpoint_configuration): <p>The endpoint configuration.</p>
16    ///   - [`included_portal_product_arns(Option<Vec::<String>>)`](crate::operation::create_portal::CreatePortalOutput::included_portal_product_arns): <p>The ARNs of the portal products included in the portal.</p>
17    ///   - [`last_modified(Option<DateTime>)`](crate::operation::create_portal::CreatePortalOutput::last_modified): <p>The timestamp when the portal configuration was last modified.</p>
18    ///   - [`last_published(Option<DateTime>)`](crate::operation::create_portal::CreatePortalOutput::last_published): <p>The timestamp when the portal was last published.</p>
19    ///   - [`last_published_description(Option<String>)`](crate::operation::create_portal::CreatePortalOutput::last_published_description): <p>A user-written description of the changes made in the last published version of the portal.</p>
20    ///   - [`portal_arn(Option<String>)`](crate::operation::create_portal::CreatePortalOutput::portal_arn): <p>The ARN of the portal.</p>
21    ///   - [`portal_content(Option<PortalContent>)`](crate::operation::create_portal::CreatePortalOutput::portal_content): <p>The name, description, and theme for the portal.</p>
22    ///   - [`portal_id(Option<String>)`](crate::operation::create_portal::CreatePortalOutput::portal_id): <p>The portal identifier.</p>
23    ///   - [`publish_status(Option<PublishStatus>)`](crate::operation::create_portal::CreatePortalOutput::publish_status): <p>The current publishing status of the portal.</p>
24    ///   - [`rum_app_monitor_name(Option<String>)`](crate::operation::create_portal::CreatePortalOutput::rum_app_monitor_name): <p>The name of the Amazon CloudWatch RUM app monitor.</p>
25    ///   - [`status_exception(Option<StatusException>)`](crate::operation::create_portal::CreatePortalOutput::status_exception): <p>Error information for failed portal operations. Contains details about any issues encountered during portal creation or publishing.</p>
26    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_portal::CreatePortalOutput::tags): <p>The collection of tags. Each tag element is associated with a given resource.</p>
27    /// - On failure, responds with [`SdkError<CreatePortalError>`](crate::operation::create_portal::CreatePortalError)
28    pub fn create_portal(&self) -> crate::operation::create_portal::builders::CreatePortalFluentBuilder {
29        crate::operation::create_portal::builders::CreatePortalFluentBuilder::new(self.handle.clone())
30    }
31}