com.amazonaws.services.workspacesweb.model

Class UpdatePortalRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workspacesweb.model.UpdatePortalRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdatePortalRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdatePortalRequest()

Method Summary

Modifier and Type	Method and Description
UpdatePortalRequest	clone()
boolean	equals(Object obj)
String	getAuthenticationType() The type of authentication integration points used when signing into the web portal.
String	getDisplayName() The name of the web portal.
String	getPortalArn() The ARN of the web portal.
int	hashCode()
void	setAuthenticationType(String authenticationType) The type of authentication integration points used when signing into the web portal.
void	setDisplayName(String displayName) The name of the web portal.
void	setPortalArn(String portalArn) The ARN of the web portal.
String	toString() Returns a string representation of this object.
UpdatePortalRequest	withAuthenticationType(AuthenticationType authenticationType) The type of authentication integration points used when signing into the web portal.
UpdatePortalRequest	withAuthenticationType(String authenticationType) The type of authentication integration points used when signing into the web portal.
UpdatePortalRequest	withDisplayName(String displayName) The name of the web portal.
UpdatePortalRequest	withPortalArn(String portalArn) The ARN of the web portal.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdatePortalRequest

public UpdatePortalRequest()

Method Detail

setAuthenticationType

public void setAuthenticationType(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.

See Also:

AuthenticationType

getAuthenticationType

public String getAuthenticationType()

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:

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.

See Also:

AuthenticationType

withAuthenticationType

public UpdatePortalRequest withAuthenticationType(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

withAuthenticationType

public UpdatePortalRequest withAuthenticationType(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

setDisplayName

public void setDisplayName(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.

getDisplayName

public String getDisplayName()

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.

withDisplayName

public UpdatePortalRequest withDisplayName(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.

setPortalArn

public void setPortalArn(String portalArn)

The ARN of the web portal.

Parameters:

portalArn - The ARN of the web portal.

getPortalArn

public String getPortalArn()

The ARN of the web portal.

Returns:

The ARN of the web portal.

withPortalArn

public UpdatePortalRequest withPortalArn(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdatePortalRequest clone()

Overrides:

clone in class AmazonWebServiceRequest