Class UpdatePortalRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdatePortalRequest.Builder,
UpdatePortalRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AuthenticationType
The type of authentication integration points used when signing into the web portal.final String
The type of authentication integration points used when signing into the web portal.static UpdatePortalRequest.Builder
builder()
final String
The name of the web portal.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final InstanceType
The type and resources of the underlying instance.final String
The type and resources of the underlying instance.final Integer
The maximum number of concurrent sessions for the portal.final String
The ARN of the web portal.static Class
<? extends UpdatePortalRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 callCreateIdentityProvider
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.If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- 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 callCreateIdentityProvider
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. - See Also:
-
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 callCreateIdentityProvider
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.If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- 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 callCreateIdentityProvider
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. - See Also:
-
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
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 returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The type and resources of the underlying instance.
- See Also:
-
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 returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The type and resources of the underlying instance.
- See Also:
-
maxConcurrentSessions
The maximum number of concurrent sessions for the portal.
- Returns:
- The maximum number of concurrent sessions for the portal.
-
portalArn
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdatePortalRequest.Builder,
UpdatePortalRequest> - Specified by:
toBuilder
in classWorkSpacesWebRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-