@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Portal extends Object implements Serializable, Cloneable, StructuredPojo
The web portal.
Constructor and Description |
---|
Portal() |
Modifier and Type | Method and Description |
---|---|
Portal |
addAdditionalEncryptionContextEntry(String key,
String value)
Add a single AdditionalEncryptionContext entry
|
Portal |
clearAdditionalEncryptionContextEntries()
Removes all the entries added into AdditionalEncryptionContext.
|
Portal |
clone() |
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 |
getBrowserSettingsArn()
The ARN of the browser settings that is associated with this web portal.
|
String |
getBrowserType()
The browser that users see when using a streaming session.
|
Date |
getCreationDate()
The creation date of the web portal.
|
String |
getCustomerManagedKey()
The customer managed key used to encrypt sensitive information in the portal.
|
String |
getDisplayName()
The name of the web portal.
|
String |
getInstanceType()
The type and resources of the underlying instance.
|
String |
getIpAccessSettingsArn()
The ARN of the IP access settings.
|
Integer |
getMaxConcurrentSessions()
The maximum number of concurrent sessions for the portal.
|
String |
getNetworkSettingsArn()
The ARN of the network settings that is associated with the web portal.
|
String |
getPortalArn()
The ARN of the web portal.
|
String |
getPortalEndpoint()
The endpoint URL of the web portal that users access in order to start streaming sessions.
|
String |
getPortalStatus()
The status of the web portal.
|
String |
getRendererType()
The renderer that is used in streaming sessions.
|
String |
getStatusReason()
A message that explains why the web portal is in its current status.
|
String |
getTrustStoreArn()
The ARN of the trust store that is associated with the web portal.
|
String |
getUserAccessLoggingSettingsArn()
The ARN of the user access logging settings that is associated with the web portal.
|
String |
getUserSettingsArn()
The ARN of the user settings that is associated with the web portal.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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 |
setBrowserSettingsArn(String browserSettingsArn)
The ARN of the browser settings that is associated with this web portal.
|
void |
setBrowserType(String browserType)
The browser that users see when using a streaming session.
|
void |
setCreationDate(Date creationDate)
The creation date of the web portal.
|
void |
setCustomerManagedKey(String customerManagedKey)
The customer managed key used to encrypt sensitive information in the portal.
|
void |
setDisplayName(String displayName)
The name of the web portal.
|
void |
setInstanceType(String instanceType)
The type and resources of the underlying instance.
|
void |
setIpAccessSettingsArn(String ipAccessSettingsArn)
The ARN of the IP access settings.
|
void |
setMaxConcurrentSessions(Integer maxConcurrentSessions)
The maximum number of concurrent sessions for the portal.
|
void |
setNetworkSettingsArn(String networkSettingsArn)
The ARN of the network settings that is associated with the web portal.
|
void |
setPortalArn(String portalArn)
The ARN of the web portal.
|
void |
setPortalEndpoint(String portalEndpoint)
The endpoint URL of the web portal that users access in order to start streaming sessions.
|
void |
setPortalStatus(String portalStatus)
The status of the web portal.
|
void |
setRendererType(String rendererType)
The renderer that is used in streaming sessions.
|
void |
setStatusReason(String statusReason)
A message that explains why the web portal is in its current status.
|
void |
setTrustStoreArn(String trustStoreArn)
The ARN of the trust store that is associated with the web portal.
|
void |
setUserAccessLoggingSettingsArn(String userAccessLoggingSettingsArn)
The ARN of the user access logging settings that is associated with the web portal.
|
void |
setUserSettingsArn(String userSettingsArn)
The ARN of the user settings that is associated with the web portal.
|
String |
toString()
Returns a string representation of this object.
|
Portal |
withAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)
The additional encryption context of the portal.
|
Portal |
withAuthenticationType(AuthenticationType authenticationType)
The type of authentication integration points used when signing into the web portal.
|
Portal |
withAuthenticationType(String authenticationType)
The type of authentication integration points used when signing into the web portal.
|
Portal |
withBrowserSettingsArn(String browserSettingsArn)
The ARN of the browser settings that is associated with this web portal.
|
Portal |
withBrowserType(BrowserType browserType)
The browser that users see when using a streaming session.
|
Portal |
withBrowserType(String browserType)
The browser that users see when using a streaming session.
|
Portal |
withCreationDate(Date creationDate)
The creation date of the web portal.
|
Portal |
withCustomerManagedKey(String customerManagedKey)
The customer managed key used to encrypt sensitive information in the portal.
|
Portal |
withDisplayName(String displayName)
The name of the web portal.
|
Portal |
withInstanceType(InstanceType instanceType)
The type and resources of the underlying instance.
|
Portal |
withInstanceType(String instanceType)
The type and resources of the underlying instance.
|
Portal |
withIpAccessSettingsArn(String ipAccessSettingsArn)
The ARN of the IP access settings.
|
Portal |
withMaxConcurrentSessions(Integer maxConcurrentSessions)
The maximum number of concurrent sessions for the portal.
|
Portal |
withNetworkSettingsArn(String networkSettingsArn)
The ARN of the network settings that is associated with the web portal.
|
Portal |
withPortalArn(String portalArn)
The ARN of the web portal.
|
Portal |
withPortalEndpoint(String portalEndpoint)
The endpoint URL of the web portal that users access in order to start streaming sessions.
|
Portal |
withPortalStatus(PortalStatus portalStatus)
The status of the web portal.
|
Portal |
withPortalStatus(String portalStatus)
The status of the web portal.
|
Portal |
withRendererType(RendererType rendererType)
The renderer that is used in streaming sessions.
|
Portal |
withRendererType(String rendererType)
The renderer that is used in streaming sessions.
|
Portal |
withStatusReason(String statusReason)
A message that explains why the web portal is in its current status.
|
Portal |
withTrustStoreArn(String trustStoreArn)
The ARN of the trust store that is associated with the web portal.
|
Portal |
withUserAccessLoggingSettingsArn(String userAccessLoggingSettingsArn)
The ARN of the user access logging settings that is associated with the web portal.
|
Portal |
withUserSettingsArn(String userSettingsArn)
The ARN of the user settings that is associated with the web portal.
|
public Map<String,String> getAdditionalEncryptionContext()
The additional encryption context of the portal.
public void setAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)
The additional encryption context of the portal.
additionalEncryptionContext
- The additional encryption context of the portal.public Portal withAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)
The additional encryption context of the portal.
additionalEncryptionContext
- The additional encryption context of the portal.public Portal addAdditionalEncryptionContextEntry(String key, String value)
public Portal clearAdditionalEncryptionContextEntries()
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.
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.
AuthenticationType
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.
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.
AuthenticationType
public Portal 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.
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.
AuthenticationType
public Portal 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.
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.
AuthenticationType
public void setBrowserSettingsArn(String browserSettingsArn)
The ARN of the browser settings that is associated with this web portal.
browserSettingsArn
- The ARN of the browser settings that is associated with this web portal.public String getBrowserSettingsArn()
The ARN of the browser settings that is associated with this web portal.
public Portal withBrowserSettingsArn(String browserSettingsArn)
The ARN of the browser settings that is associated with this web portal.
browserSettingsArn
- The ARN of the browser settings that is associated with this web portal.public void setBrowserType(String browserType)
The browser that users see when using a streaming session.
browserType
- The browser that users see when using a streaming session.BrowserType
public String getBrowserType()
The browser that users see when using a streaming session.
BrowserType
public Portal withBrowserType(String browserType)
The browser that users see when using a streaming session.
browserType
- The browser that users see when using a streaming session.BrowserType
public Portal withBrowserType(BrowserType browserType)
The browser that users see when using a streaming session.
browserType
- The browser that users see when using a streaming session.BrowserType
public void setCreationDate(Date creationDate)
The creation date of the web portal.
creationDate
- The creation date of the web portal.public Date getCreationDate()
The creation date of the web portal.
public Portal withCreationDate(Date creationDate)
The creation date of the web portal.
creationDate
- The creation date of the web portal.public void setCustomerManagedKey(String customerManagedKey)
The customer managed key used to encrypt sensitive information in the portal.
customerManagedKey
- The customer managed key used to encrypt sensitive information in the portal.public String getCustomerManagedKey()
The customer managed key used to encrypt sensitive information in the portal.
public Portal withCustomerManagedKey(String customerManagedKey)
The customer managed key used to encrypt sensitive information in the portal.
customerManagedKey
- The customer managed key used to encrypt sensitive information in the portal.public void setDisplayName(String displayName)
The name of the web portal.
displayName
- The name of the web portal.public String getDisplayName()
The name of the web portal.
public Portal withDisplayName(String displayName)
The name of the web portal.
displayName
- The name of the web portal.public void setInstanceType(String instanceType)
The type and resources of the underlying instance.
instanceType
- The type and resources of the underlying instance.InstanceType
public String getInstanceType()
The type and resources of the underlying instance.
InstanceType
public Portal withInstanceType(String instanceType)
The type and resources of the underlying instance.
instanceType
- The type and resources of the underlying instance.InstanceType
public Portal withInstanceType(InstanceType instanceType)
The type and resources of the underlying instance.
instanceType
- The type and resources of the underlying instance.InstanceType
public void setIpAccessSettingsArn(String ipAccessSettingsArn)
The ARN of the IP access settings.
ipAccessSettingsArn
- The ARN of the IP access settings.public String getIpAccessSettingsArn()
The ARN of the IP access settings.
public Portal withIpAccessSettingsArn(String ipAccessSettingsArn)
The ARN of the IP access settings.
ipAccessSettingsArn
- The ARN of the IP access settings.public void setMaxConcurrentSessions(Integer maxConcurrentSessions)
The maximum number of concurrent sessions for the portal.
maxConcurrentSessions
- The maximum number of concurrent sessions for the portal.public Integer getMaxConcurrentSessions()
The maximum number of concurrent sessions for the portal.
public Portal withMaxConcurrentSessions(Integer maxConcurrentSessions)
The maximum number of concurrent sessions for the portal.
maxConcurrentSessions
- The maximum number of concurrent sessions for the portal.public void setNetworkSettingsArn(String networkSettingsArn)
The ARN of the network settings that is associated with the web portal.
networkSettingsArn
- The ARN of the network settings that is associated with the web portal.public String getNetworkSettingsArn()
The ARN of the network settings that is associated with the web portal.
public Portal withNetworkSettingsArn(String networkSettingsArn)
The ARN of the network settings that is associated with the web portal.
networkSettingsArn
- The ARN of the network settings that is associated with the web portal.public void setPortalArn(String portalArn)
The ARN of the web portal.
portalArn
- The ARN of the web portal.public String getPortalArn()
The ARN of the web portal.
public Portal withPortalArn(String portalArn)
The ARN of the web portal.
portalArn
- The ARN of the web portal.public void setPortalEndpoint(String portalEndpoint)
The endpoint URL of the web portal that users access in order to start streaming sessions.
portalEndpoint
- The endpoint URL of the web portal that users access in order to start streaming sessions.public String getPortalEndpoint()
The endpoint URL of the web portal that users access in order to start streaming sessions.
public Portal withPortalEndpoint(String portalEndpoint)
The endpoint URL of the web portal that users access in order to start streaming sessions.
portalEndpoint
- The endpoint URL of the web portal that users access in order to start streaming sessions.public void setPortalStatus(String portalStatus)
The status of the web portal.
portalStatus
- The status of the web portal.PortalStatus
public String getPortalStatus()
The status of the web portal.
PortalStatus
public Portal withPortalStatus(String portalStatus)
The status of the web portal.
portalStatus
- The status of the web portal.PortalStatus
public Portal withPortalStatus(PortalStatus portalStatus)
The status of the web portal.
portalStatus
- The status of the web portal.PortalStatus
public void setRendererType(String rendererType)
The renderer that is used in streaming sessions.
rendererType
- The renderer that is used in streaming sessions.RendererType
public String getRendererType()
The renderer that is used in streaming sessions.
RendererType
public Portal withRendererType(String rendererType)
The renderer that is used in streaming sessions.
rendererType
- The renderer that is used in streaming sessions.RendererType
public Portal withRendererType(RendererType rendererType)
The renderer that is used in streaming sessions.
rendererType
- The renderer that is used in streaming sessions.RendererType
public void setStatusReason(String statusReason)
A message that explains why the web portal is in its current status.
statusReason
- A message that explains why the web portal is in its current status.public String getStatusReason()
A message that explains why the web portal is in its current status.
public Portal withStatusReason(String statusReason)
A message that explains why the web portal is in its current status.
statusReason
- A message that explains why the web portal is in its current status.public void setTrustStoreArn(String trustStoreArn)
The ARN of the trust store that is associated with the web portal.
trustStoreArn
- The ARN of the trust store that is associated with the web portal.public String getTrustStoreArn()
The ARN of the trust store that is associated with the web portal.
public Portal withTrustStoreArn(String trustStoreArn)
The ARN of the trust store that is associated with the web portal.
trustStoreArn
- The ARN of the trust store that is associated with the web portal.public void setUserAccessLoggingSettingsArn(String userAccessLoggingSettingsArn)
The ARN of the user access logging settings that is associated with the web portal.
userAccessLoggingSettingsArn
- The ARN of the user access logging settings that is associated with the web portal.public String getUserAccessLoggingSettingsArn()
The ARN of the user access logging settings that is associated with the web portal.
public Portal withUserAccessLoggingSettingsArn(String userAccessLoggingSettingsArn)
The ARN of the user access logging settings that is associated with the web portal.
userAccessLoggingSettingsArn
- The ARN of the user access logging settings that is associated with the web portal.public void setUserSettingsArn(String userSettingsArn)
The ARN of the user settings that is associated with the web portal.
userSettingsArn
- The ARN of the user settings that is associated with the web portal.public String getUserSettingsArn()
The ARN of the user settings that is associated with the web portal.
public Portal withUserSettingsArn(String userSettingsArn)
The ARN of the user settings that is associated with the web portal.
userSettingsArn
- The ARN of the user settings that is associated with the web portal.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.