Interface UpdatePortalRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdatePortalRequest

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

Method Summary

Modifier and Type	Method	Description
UpdatePortalRequest.Builder	authenticationType(String authenticationType)	The type of authentication integration points used when signing into the web portal.
UpdatePortalRequest.Builder	authenticationType(AuthenticationType 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	instanceType(String instanceType)	The type and resources of the underlying instance.
UpdatePortalRequest.Builder	instanceType(InstanceType instanceType)	The type and resources of the underlying instance.
UpdatePortalRequest.Builder	maxConcurrentSessions(Integer maxConcurrentSessions)	The maximum number of concurrent sessions for the portal.
UpdatePortalRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdatePortalRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdatePortalRequest.Builder	portalArn(String portalArn)	The ARN of the web portal.

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

overrideConfiguration

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

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

build

Method Details

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 IAM Identity Center. 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 IAM Identity Center. 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 IAM Identity Center. 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 IAM Identity Center. 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.

instanceType

UpdatePortalRequest.Builder instanceType(String instanceType)

The type and resources of the underlying instance.

Parameters:

instanceType - The type and resources of the underlying instance.

Returns:

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

See Also:

• InstanceType
• InstanceType

instanceType

UpdatePortalRequest.Builder instanceType(InstanceType instanceType)

The type and resources of the underlying instance.

Parameters:

instanceType - The type and resources of the underlying instance.

Returns:

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

See Also:

• InstanceType
• InstanceType

maxConcurrentSessions

UpdatePortalRequest.Builder maxConcurrentSessions(Integer maxConcurrentSessions)

The maximum number of concurrent sessions for the portal.

Parameters:

maxConcurrentSessions - The maximum number of concurrent sessions for the 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)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.