Struct aws_sdk_workspacesweb::operation::create_portal::CreatePortalInput

#[non_exhaustive]
pub struct CreatePortalInput {
    pub display_name: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub customer_managed_key: Option<String>,
    pub additional_encryption_context: Option<HashMap<String, String>>,
    pub client_token: Option<String>,
    pub authentication_type: Option<AuthenticationType>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

display_name: Option<String>

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

tags: Option<Vec<Tag>>

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

customer_managed_key: Option<String>

The customer managed key of the web portal.

additional_encryption_context: Option<HashMap<String, String>>

The additional encryption context of the portal.

client_token: Option<String>

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.

authentication_type: Option<AuthenticationType>

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.

Implementations

impl CreatePortalInput

pub fn display_name(&self) -> Option<&str>

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

pub fn tags(&self) -> &[Tag]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn customer_managed_key(&self) -> Option<&str>

The customer managed key of the web portal.

pub fn additional_encryption_context(&self) -> Option<&HashMap<String, String>>

The additional encryption context of the portal.

pub fn client_token(&self) -> Option<&str>

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) -> Option<&AuthenticationType>

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.

impl CreatePortalInput

pub fn builder() -> CreatePortalInputBuilder

Creates a new builder-style object to manufacture CreatePortalInput.

Trait Implementations

impl Clone for CreatePortalInput

fn clone(&self) -> CreatePortalInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreatePortalInput

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

Formats the value using the given formatter.

impl PartialEq for CreatePortalInput

fn eq(&self, other: &CreatePortalInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreatePortalInput