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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreatePortalRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`additionalEncryptionContext()`	The additional encryption context of the portal.
`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 CreatePortalRequest.Builder`	`builder()`
`String`	`clientToken()`	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`String`	`customerManagedKey()`	The customer managed key of the web portal.
`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)`
`boolean`	`hasAdditionalEncryptionContext()`	For responses, this returns true if the service returned a value for the AdditionalEncryptionContext property.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreatePortalRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	The tags to add to the web portal.
`CreatePortalRequest.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
  - hasAdditionalEncryptionContext
```
public final boolean hasAdditionalEncryptionContext()
```
    For responses, this returns true if the service returned a value for the AdditionalEncryptionContext property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - additionalEncryptionContext
```
public final Map<String,String> additionalEncryptionContext()
```
    The additional encryption context of the portal.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalEncryptionContext() method.
    
    Returns:
    
    The additional encryption context of the portal.
  - 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 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.
    
    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 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
  - 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 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.
    
    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 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
  - clientToken
```
public final 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 AWS 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 AWS SDK.
  - customerManagedKey
```
public final String customerManagedKey()
```
    The customer managed key of the web portal.
    
    Returns:
    
    The customer managed key of the web portal.
  - 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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    The tags to add to the web portal. A tag is a key-value pair.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags to add to the web portal. A tag is a key-value pair.
  - toBuilder
```
public CreatePortalRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>
    
    Specified by:
    
    toBuilder in class WorkSpacesWebRequest
  - builder
```
public static CreatePortalRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreatePortalRequest.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

Class CreatePortalRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

hasAdditionalEncryptionContext

additionalEncryptionContext

authenticationType

authenticationTypeAsString

clientToken

customerManagedKey

displayName

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields