Struct aws_sdk_workspacesweb::client::fluent_builders::CreatePortal

pub struct CreatePortal { /* private fields */ }

Fluent builder constructing a request to CreatePortal.

Creates a web portal.

Implementations

impl CreatePortal

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreatePortal, AwsResponseRetryClassifier>, SdkError<CreatePortalError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreatePortalOutput, SdkError<CreatePortalError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn display_name(self, input: impl Into<String>) -> Self

The name of the web portal. This is not visible to users who log into the web portal.

pub fn set_display_name(self, input: Option<String>) -> Self

The name of the web portal. This is not visible to users who log into the web portal.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

The tags to add to the web portal. A tag is a key-value pair.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The tags to add to the web portal. A tag is a key-value pair.

pub fn customer_managed_key(self, input: impl Into<String>) -> Self

The customer managed key of the web portal.

pub fn set_customer_managed_key(self, input: Option<String>) -> Self

The customer managed key of the web portal.

pub fn additional_encryption_context(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to additionalEncryptionContext.

To override the contents of this collection use set_additional_encryption_context.

The additional encryption context of the portal.

pub fn set_additional_encryption_context(
    self,
    input: Option<HashMap<String, String>>
) -> Self

The additional encryption context of the portal.

pub fn client_token(self, input: impl Into<String>) -> Self

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

pub fn set_client_token(self, input: Option<String>) -> Self

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

pub fn authentication_type(self, input: AuthenticationType) -> Self

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

pub fn set_authentication_type(self, input: Option<AuthenticationType>) -> Self

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

Trait Implementations

impl Clone for CreatePortal

fn clone(&self) -> CreatePortal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreatePortal

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

Formats the value using the given formatter.