com.amazonaws.services.workspacesweb.model

Class CreatePortalRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workspacesweb.model.CreatePortalRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreatePortalRequest
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
CreatePortalRequest()

Method Summary

Modifier and Type	Method and Description
CreatePortalRequest	addAdditionalEncryptionContextEntry(String key, String value) Add a single AdditionalEncryptionContext entry
CreatePortalRequest	clearAdditionalEncryptionContextEntries() Removes all the entries added into AdditionalEncryptionContext.
CreatePortalRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Map<String,String>	getAdditionalEncryptionContext() The additional encryption context of the portal.
String	getAuthenticationType() The type of authentication integration points used when signing into the web portal.
String	getClientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getCustomerManagedKey() The customer managed key of the web portal.
String	getDisplayName() The name of the web portal.
String	getInstanceType() The type and resources of the underlying instance.
Integer	getMaxConcurrentSessions() The maximum number of concurrent sessions for the portal.
List<Tag>	getTags() The tags to add to the web portal.
int	hashCode()
void	setAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext) The additional encryption context of the portal.
void	setAuthenticationType(String authenticationType) The type of authentication integration points used when signing into the web portal.
void	setClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setCustomerManagedKey(String customerManagedKey) The customer managed key of the web portal.
void	setDisplayName(String displayName) The name of the web portal.
void	setInstanceType(String instanceType) The type and resources of the underlying instance.
void	setMaxConcurrentSessions(Integer maxConcurrentSessions) The maximum number of concurrent sessions for the portal.
void	setTags(Collection<Tag> tags) The tags to add to the web portal.
String	toString() Returns a string representation of this object.
CreatePortalRequest	withAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext) The additional encryption context of the portal.
CreatePortalRequest	withAuthenticationType(AuthenticationType authenticationType) The type of authentication integration points used when signing into the web portal.
CreatePortalRequest	withAuthenticationType(String authenticationType) The type of authentication integration points used when signing into the web portal.
CreatePortalRequest	withClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreatePortalRequest	withCustomerManagedKey(String customerManagedKey) The customer managed key of the web portal.
CreatePortalRequest	withDisplayName(String displayName) The name of the web portal.
CreatePortalRequest	withInstanceType(InstanceType instanceType) The type and resources of the underlying instance.
CreatePortalRequest	withInstanceType(String instanceType) The type and resources of the underlying instance.
CreatePortalRequest	withMaxConcurrentSessions(Integer maxConcurrentSessions) The maximum number of concurrent sessions for the portal.
CreatePortalRequest	withTags(Collection<Tag> tags) The tags to add to the web portal.
CreatePortalRequest	withTags(Tag... tags) The tags to add to the web portal.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreatePortalRequest

public CreatePortalRequest()

Method Detail

getAdditionalEncryptionContext

public Map<String,String> getAdditionalEncryptionContext()

The additional encryption context of the portal.

Returns:

The additional encryption context of the portal.

setAdditionalEncryptionContext

public void setAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)

The additional encryption context of the portal.

Parameters:

additionalEncryptionContext - The additional encryption context of the portal.

withAdditionalEncryptionContext

public CreatePortalRequest withAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)

The additional encryption context of the portal.

Parameters:

additionalEncryptionContext - The additional encryption context of the portal.

Returns:

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

addAdditionalEncryptionContextEntry

public CreatePortalRequest addAdditionalEncryptionContextEntry(String key,
                                                               String value)

Add a single AdditionalEncryptionContext entry

See Also:

withAdditionalEncryptionContext(java.util.Map<java.lang.String, java.lang.String>)

clearAdditionalEncryptionContextEntries

public CreatePortalRequest clearAdditionalEncryptionContextEntries()

Removes all the entries added into AdditionalEncryptionContext.

Returns:

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

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 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.

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 (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

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 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.

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

withAuthenticationType

public CreatePortalRequest 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 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.

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 (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.

Returns:

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

See Also:

AuthenticationType

withAuthenticationType

public CreatePortalRequest 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 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.

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 (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.

Returns:

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

See Also:

AuthenticationType

setClientToken

public void setClientToken(String clientToken)

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 Amazon Web Services SDK.

Parameters:

clientToken - 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 Amazon Web Services SDK.

getClientToken

public String getClientToken()

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 Amazon Web Services SDK.

Returns:

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 Amazon Web Services SDK.

withClientToken

public CreatePortalRequest withClientToken(String clientToken)

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 Amazon Web Services SDK.

Parameters:

clientToken - 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 Amazon Web Services SDK.

Returns:

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

setCustomerManagedKey

public void setCustomerManagedKey(String customerManagedKey)

The customer managed key of the web portal.

Parameters:

customerManagedKey - The customer managed key of the web portal.

getCustomerManagedKey

public String getCustomerManagedKey()

The customer managed key of the web portal.

Returns:

The customer managed key of the web portal.

withCustomerManagedKey

public CreatePortalRequest withCustomerManagedKey(String customerManagedKey)

The customer managed key of the web portal.

Parameters:

customerManagedKey - The customer managed key of the web portal.

Returns:

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

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 CreatePortalRequest 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.

setInstanceType

public void setInstanceType(String instanceType)

The type and resources of the underlying instance.

Parameters:

instanceType - The type and resources of the underlying instance.

See Also:

InstanceType

getInstanceType

public String getInstanceType()

The type and resources of the underlying instance.

Returns:

The type and resources of the underlying instance.

See Also:

InstanceType

withInstanceType

public CreatePortalRequest withInstanceType(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

withInstanceType

public CreatePortalRequest withInstanceType(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

setMaxConcurrentSessions

public void setMaxConcurrentSessions(Integer maxConcurrentSessions)

The maximum number of concurrent sessions for the portal.

Parameters:

maxConcurrentSessions - The maximum number of concurrent sessions for the portal.

getMaxConcurrentSessions

public Integer getMaxConcurrentSessions()

The maximum number of concurrent sessions for the portal.

Returns:

The maximum number of concurrent sessions for the portal.

withMaxConcurrentSessions

public CreatePortalRequest withMaxConcurrentSessions(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.

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(Collection<Tag> tags)

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

Parameters:

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

withTags

public CreatePortalRequest withTags(Tag... tags)

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

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

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

withTags

public CreatePortalRequest withTags(Collection<Tag> tags)

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

Parameters:

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

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 CreatePortalRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()