/AWS1/CL_WSWPORTAL¶
The web portal.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_portalarn TYPE /AWS1/WSWARN /AWS1/WSWARN¶
The ARN of the web portal.
Optional arguments:¶
iv_renderertype TYPE /AWS1/WSWRENDERERTYPE /AWS1/WSWRENDERERTYPE¶
The renderer that is used in streaming sessions.
iv_browsertype TYPE /AWS1/WSWBROWSERTYPE /AWS1/WSWBROWSERTYPE¶
The browser that users see when using a streaming session.
iv_portalstatus TYPE /AWS1/WSWPORTALSTATUS /AWS1/WSWPORTALSTATUS¶
The status of the web portal.
iv_portalendpoint TYPE /AWS1/WSWPORTALENDPOINT /AWS1/WSWPORTALENDPOINT¶
The endpoint URL of the web portal that users access in order to start streaming sessions.
iv_displayname TYPE /AWS1/WSWDISPLAYNAME /AWS1/WSWDISPLAYNAME¶
The name of the web portal.
iv_creationdate TYPE /AWS1/WSWTIMESTAMP /AWS1/WSWTIMESTAMP¶
The creation date of the web portal.
iv_browsersettingsarn TYPE /AWS1/WSWARN /AWS1/WSWARN¶
The ARN of the browser settings that is associated with this web portal.
iv_dataprotectionsettingsarn TYPE /AWS1/WSWARN /AWS1/WSWARN¶
The ARN of the data protection settings.
iv_usersettingsarn TYPE /AWS1/WSWARN /AWS1/WSWARN¶
The ARN of the user settings that is associated with the web portal.
iv_networksettingsarn TYPE /AWS1/WSWARN /AWS1/WSWARN¶
The ARN of the network settings that is associated with the web portal.
iv_sessionloggerarn TYPE /AWS1/WSWARN /AWS1/WSWARN¶
The ARN of the session logger that is assocaited with the portal.
iv_truststorearn TYPE /AWS1/WSWARN /AWS1/WSWARN¶
The ARN of the trust store that is associated with the web portal.
iv_statusreason TYPE /AWS1/WSWSTATUSREASON /AWS1/WSWSTATUSREASON¶
A message that explains why the web portal is in its current status.
iv_useraccessloggingstgsarn TYPE /AWS1/WSWARN /AWS1/WSWARN¶
The ARN of the user access logging settings that is associated with the web portal.
iv_authenticationtype TYPE /AWS1/WSWAUTHENTICATIONTYPE /AWS1/WSWAUTHENTICATIONTYPE¶
The type of authentication integration points used when signing into the web portal. Defaults to
Standard.
Standardweb portals are authenticated directly through your identity provider. You need to callCreateIdentityProviderto integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM Identity Centerweb 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.
iv_ipaccesssettingsarn TYPE /AWS1/WSWARN /AWS1/WSWARN¶
The ARN of the IP access settings.
iv_customermanagedkey TYPE /AWS1/WSWKEYARN /AWS1/WSWKEYARN¶
The customer managed key used to encrypt sensitive information in the portal.
it_additionalenccontext TYPE /AWS1/CL_WSWENCCONTEXTMAP_W=>TT_ENCRYPTIONCONTEXTMAP TT_ENCRYPTIONCONTEXTMAP¶
The additional encryption context of the portal.
iv_instancetype TYPE /AWS1/WSWINSTANCETYPE /AWS1/WSWINSTANCETYPE¶
The type and resources of the underlying instance.
iv_maxconcurrentsessions TYPE /AWS1/WSWMAXCONCURRENTSESSIONS /AWS1/WSWMAXCONCURRENTSESSIONS¶
The maximum number of concurrent sessions for the portal.
Queryable Attributes¶
portalArn¶
The ARN of the web portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PORTALARN() |
Getter for PORTALARN, with configurable default |
ASK_PORTALARN() |
Getter for PORTALARN w/ exceptions if field has no value |
HAS_PORTALARN() |
Determine if PORTALARN has a value |
rendererType¶
The renderer that is used in streaming sessions.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RENDERERTYPE() |
Getter for RENDERERTYPE, with configurable default |
ASK_RENDERERTYPE() |
Getter for RENDERERTYPE w/ exceptions if field has no value |
HAS_RENDERERTYPE() |
Determine if RENDERERTYPE has a value |
browserType¶
The browser that users see when using a streaming session.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BROWSERTYPE() |
Getter for BROWSERTYPE, with configurable default |
ASK_BROWSERTYPE() |
Getter for BROWSERTYPE w/ exceptions if field has no value |
HAS_BROWSERTYPE() |
Determine if BROWSERTYPE has a value |
portalStatus¶
The status of the web portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PORTALSTATUS() |
Getter for PORTALSTATUS, with configurable default |
ASK_PORTALSTATUS() |
Getter for PORTALSTATUS w/ exceptions if field has no value |
HAS_PORTALSTATUS() |
Determine if PORTALSTATUS has a value |
portalEndpoint¶
The endpoint URL of the web portal that users access in order to start streaming sessions.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PORTALENDPOINT() |
Getter for PORTALENDPOINT, with configurable default |
ASK_PORTALENDPOINT() |
Getter for PORTALENDPOINT w/ exceptions if field has no valu |
HAS_PORTALENDPOINT() |
Determine if PORTALENDPOINT has a value |
displayName¶
The name of the web portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISPLAYNAME() |
Getter for DISPLAYNAME, with configurable default |
ASK_DISPLAYNAME() |
Getter for DISPLAYNAME w/ exceptions if field has no value |
HAS_DISPLAYNAME() |
Determine if DISPLAYNAME has a value |
creationDate¶
The creation date of the web portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
browserSettingsArn¶
The ARN of the browser settings that is associated with this web portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BROWSERSETTINGSARN() |
Getter for BROWSERSETTINGSARN, with configurable default |
ASK_BROWSERSETTINGSARN() |
Getter for BROWSERSETTINGSARN w/ exceptions if field has no |
HAS_BROWSERSETTINGSARN() |
Determine if BROWSERSETTINGSARN has a value |
dataProtectionSettingsArn¶
The ARN of the data protection settings.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATAPROTECTIONSTGSARN() |
Getter for DATAPROTECTIONSETTINGSARN, with configurable defa |
ASK_DATAPROTECTIONSTGSARN() |
Getter for DATAPROTECTIONSETTINGSARN w/ exceptions if field |
HAS_DATAPROTECTIONSTGSARN() |
Determine if DATAPROTECTIONSETTINGSARN has a value |
userSettingsArn¶
The ARN of the user settings that is associated with the web portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERSETTINGSARN() |
Getter for USERSETTINGSARN, with configurable default |
ASK_USERSETTINGSARN() |
Getter for USERSETTINGSARN w/ exceptions if field has no val |
HAS_USERSETTINGSARN() |
Determine if USERSETTINGSARN has a value |
networkSettingsArn¶
The ARN of the network settings that is associated with the web portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NETWORKSETTINGSARN() |
Getter for NETWORKSETTINGSARN, with configurable default |
ASK_NETWORKSETTINGSARN() |
Getter for NETWORKSETTINGSARN w/ exceptions if field has no |
HAS_NETWORKSETTINGSARN() |
Determine if NETWORKSETTINGSARN has a value |
sessionLoggerArn¶
The ARN of the session logger that is assocaited with the portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SESSIONLOGGERARN() |
Getter for SESSIONLOGGERARN, with configurable default |
ASK_SESSIONLOGGERARN() |
Getter for SESSIONLOGGERARN w/ exceptions if field has no va |
HAS_SESSIONLOGGERARN() |
Determine if SESSIONLOGGERARN has a value |
trustStoreArn¶
The ARN of the trust store that is associated with the web portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRUSTSTOREARN() |
Getter for TRUSTSTOREARN, with configurable default |
ASK_TRUSTSTOREARN() |
Getter for TRUSTSTOREARN w/ exceptions if field has no value |
HAS_TRUSTSTOREARN() |
Determine if TRUSTSTOREARN has a value |
statusReason¶
A message that explains why the web portal is in its current status.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSREASON() |
Getter for STATUSREASON, with configurable default |
ASK_STATUSREASON() |
Getter for STATUSREASON w/ exceptions if field has no value |
HAS_STATUSREASON() |
Determine if STATUSREASON has a value |
userAccessLoggingSettingsArn¶
The ARN of the user access logging settings that is associated with the web portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERACCESSLOGGINGSTGSARN() |
Getter for USERACCESSLOGGINGSETTINGSARN, with configurable d |
ASK_USERACCESSLOGGINGSTGSARN() |
Getter for USERACCESSLOGGINGSETTINGSARN w/ exceptions if fie |
HAS_USERACCESSLOGGINGSTGSARN() |
Determine if USERACCESSLOGGINGSETTINGSARN has a value |
authenticationType¶
The type of authentication integration points used when signing into the web portal. Defaults to
Standard.
Standardweb portals are authenticated directly through your identity provider. You need to callCreateIdentityProviderto integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM Identity Centerweb 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHENTICATIONTYPE() |
Getter for AUTHENTICATIONTYPE, with configurable default |
ASK_AUTHENTICATIONTYPE() |
Getter for AUTHENTICATIONTYPE w/ exceptions if field has no |
HAS_AUTHENTICATIONTYPE() |
Determine if AUTHENTICATIONTYPE has a value |
ipAccessSettingsArn¶
The ARN of the IP access settings.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IPACCESSSETTINGSARN() |
Getter for IPACCESSSETTINGSARN, with configurable default |
ASK_IPACCESSSETTINGSARN() |
Getter for IPACCESSSETTINGSARN w/ exceptions if field has no |
HAS_IPACCESSSETTINGSARN() |
Determine if IPACCESSSETTINGSARN has a value |
customerManagedKey¶
The customer managed key used to encrypt sensitive information in the portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CUSTOMERMANAGEDKEY() |
Getter for CUSTOMERMANAGEDKEY, with configurable default |
ASK_CUSTOMERMANAGEDKEY() |
Getter for CUSTOMERMANAGEDKEY w/ exceptions if field has no |
HAS_CUSTOMERMANAGEDKEY() |
Determine if CUSTOMERMANAGEDKEY has a value |
additionalEncryptionContext¶
The additional encryption context of the portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ADDITIONALENCCONTEXT() |
Getter for ADDITIONALENCRYPTIONCONTEXT, with configurable de |
ASK_ADDITIONALENCCONTEXT() |
Getter for ADDITIONALENCRYPTIONCONTEXT w/ exceptions if fiel |
HAS_ADDITIONALENCCONTEXT() |
Determine if ADDITIONALENCRYPTIONCONTEXT has a value |
instanceType¶
The type and resources of the underlying instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCETYPE() |
Getter for INSTANCETYPE, with configurable default |
ASK_INSTANCETYPE() |
Getter for INSTANCETYPE w/ exceptions if field has no value |
HAS_INSTANCETYPE() |
Determine if INSTANCETYPE has a value |
maxConcurrentSessions¶
The maximum number of concurrent sessions for the portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAXCONCURRENTSESSIONS() |
Getter for MAXCONCURRENTSESSIONS, with configurable default |
ASK_MAXCONCURRENTSESSIONS() |
Getter for MAXCONCURRENTSESSIONS w/ exceptions if field has |
HAS_MAXCONCURRENTSESSIONS() |
Determine if MAXCONCURRENTSESSIONS has a value |