Package software.amazon.awssdk.services.workspacesweb.model

Class UpdatePortalRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workspacesweb.model.WorkSpacesWebRequest

software.amazon.awssdk.services.workspacesweb.model.UpdatePortalRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdatePortalRequest
extends WorkSpacesWebRequest
implements ToCopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdatePortalRequest.Builder

Method Summary

Modifier and Type	Method	Description
AuthenticationType	authenticationType()	The type of authentication integration points used when signing into the web portal.
String	authenticationTypeAsString()	The type of authentication integration points used when signing into the web portal.
static UpdatePortalRequest.Builder	builder()
String	displayName()	The name of the web portal.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InstanceType	instanceType()	The type and resources of the underlying instance.
String	instanceTypeAsString()	The type and resources of the underlying instance.
Integer	maxConcurrentSessions()	The maximum number of concurrent sessions for the portal.
String	portalArn()	The ARN of the web portal.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdatePortalRequest.Builder>	serializableBuilderClass()
UpdatePortalRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

authenticationType

public final 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 (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

Returns:

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 (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

See Also:

AuthenticationType

authenticationTypeAsString

public final String authenticationTypeAsString()

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 (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

Returns:

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 (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

See Also:

AuthenticationType

displayName

public final String displayName()

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

Returns:

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

instanceType

public final InstanceType instanceType()

The type and resources of the underlying instance.

If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The type and resources of the underlying instance.

See Also:

InstanceType

instanceTypeAsString

public final String instanceTypeAsString()

The type and resources of the underlying instance.

If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The type and resources of the underlying instance.

See Also:

InstanceType

maxConcurrentSessions

public final Integer maxConcurrentSessions()

The maximum number of concurrent sessions for the portal.

Returns:

The maximum number of concurrent sessions for the portal.

portalArn

public final String portalArn()

The ARN of the web portal.

Returns:

The ARN of the web portal.

toBuilder

public UpdatePortalRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>

Specified by:

toBuilder in class WorkSpacesWebRequest

builder

public static UpdatePortalRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdatePortalRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo