software.amazon.awssdk.services.workspacesweb.model

Interface UpdatePortalRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>, SdkBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>, SdkPojo, SdkRequest.Builder, WorkSpacesWebRequest.Builder

Enclosing class:

UpdatePortalRequest

public static interface UpdatePortalRequest.Builder
extends WorkSpacesWebRequest.Builder, SdkPojo, CopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>

Method Summary

Modifier and Type	Method and Description
UpdatePortalRequest.Builder	authenticationType(AuthenticationType authenticationType) The type of authentication integration points used when signing into the web portal.
UpdatePortalRequest.Builder	authenticationType(String authenticationType) The type of authentication integration points used when signing into the web portal.
UpdatePortalRequest.Builder	displayName(String displayName) The name of the web portal.
UpdatePortalRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdatePortalRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdatePortalRequest.Builder	portalArn(String portalArn) The ARN of the web portal.

Methods inherited from interface software.amazon.awssdk.services.workspacesweb.model.WorkSpacesWebRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

authenticationType

UpdatePortalRequest.Builder authenticationType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationType, AuthenticationType

authenticationType

UpdatePortalRequest.Builder authenticationType(AuthenticationType 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationType, AuthenticationType

displayName

UpdatePortalRequest.Builder displayName(String displayName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

portalArn

UpdatePortalRequest.Builder portalArn(String portalArn)

The ARN of the web portal.

Parameters:

portalArn - The ARN of the web portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

UpdatePortalRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdatePortalRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder