Amazonka.WorkSpacesWeb.Types.Portal

Documentation

data Portal

The web portal.

See: newPortal smart constructor.

Constructors

Portal'

Fields

• browserSettingsArn :: Maybe Text

  The ARN of the browser settings that is associated with this web portal.

• browserType :: Maybe BrowserType

  The browser that users see when using a streaming session.

• creationDate :: Maybe POSIX

  The creation date of the web portal.

• displayName :: Maybe (Sensitive Text)

  The name of the web portal.

• networkSettingsArn :: Maybe Text

  The ARN of the network settings that is associated with the web portal.

• portalArn :: Maybe Text

  The ARN of the web portal.

• portalEndpoint :: Maybe Text

  The endpoint URL of the web portal that users access in order to start streaming sessions.

• portalStatus :: Maybe PortalStatus

  The status of the web portal.

• rendererType :: Maybe RendererType

  The renderer that is used in streaming sessions.

• statusReason :: Maybe Text

  A message that explains why the web portal is in its current status.

• trustStoreArn :: Maybe Text

  The ARN of the trust store that is associated with the web portal.

• userAccessLoggingSettingsArn :: Maybe Text

  The ARN of the user access logging settings that is associated with the web portal.

• userSettingsArn :: Maybe Text

  The ARN of the user settings that is associated with the web portal.

Instances

FromJSON Portal

Defined in Amazonka.WorkSpacesWeb.Types.Portal

Methods

parseJSON :: Value -> Parser Portal

parseJSONList :: Value -> Parser [Portal]

Generic Portal

Defined in Amazonka.WorkSpacesWeb.Types.Portal

Associated Types

type Rep Portal :: Type -> Type

Methods

from :: Portal -> Rep Portal x

to :: Rep Portal x -> Portal

Show Portal

Defined in Amazonka.WorkSpacesWeb.Types.Portal

Methods

showsPrec :: Int -> Portal -> ShowS

show :: Portal -> String

showList :: [Portal] -> ShowS

NFData Portal

Defined in Amazonka.WorkSpacesWeb.Types.Portal

Methods

rnf :: Portal -> ()

Eq Portal

Defined in Amazonka.WorkSpacesWeb.Types.Portal

Methods

(==) :: Portal -> Portal -> Bool

(/=) :: Portal -> Portal -> Bool

Hashable Portal

Defined in Amazonka.WorkSpacesWeb.Types.Portal

Methods

hashWithSalt :: Int -> Portal -> Int

hash :: Portal -> Int

type Rep Portal

Defined in Amazonka.WorkSpacesWeb.Types.Portal

type Rep Portal = D1 ('MetaData "Portal" "Amazonka.WorkSpacesWeb.Types.Portal" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "Portal'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "browserSettingsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "browserType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BrowserType)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "networkSettingsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "portalArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "portalEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "portalStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PortalStatus)) :*: S1 ('MetaSel ('Just "rendererType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RendererType)))) :*: ((S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "trustStoreArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "userAccessLoggingSettingsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userSettingsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newPortal :: Portal

Create a value of Portal with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:browserSettingsArn:Portal', portal_browserSettingsArn - The ARN of the browser settings that is associated with this web portal.

$sel:browserType:Portal', portal_browserType - The browser that users see when using a streaming session.

$sel:creationDate:Portal', portal_creationDate - The creation date of the web portal.

$sel:displayName:Portal', portal_displayName - The name of the web portal.

$sel:networkSettingsArn:Portal', portal_networkSettingsArn - The ARN of the network settings that is associated with the web portal.

$sel:portalArn:Portal', portal_portalArn - The ARN of the web portal.

$sel:portalEndpoint:Portal', portal_portalEndpoint - The endpoint URL of the web portal that users access in order to start streaming sessions.

$sel:portalStatus:Portal', portal_portalStatus - The status of the web portal.

$sel:rendererType:Portal', portal_rendererType - The renderer that is used in streaming sessions.

$sel:statusReason:Portal', portal_statusReason - A message that explains why the web portal is in its current status.

$sel:trustStoreArn:Portal', portal_trustStoreArn - The ARN of the trust store that is associated with the web portal.

$sel:userAccessLoggingSettingsArn:Portal', portal_userAccessLoggingSettingsArn - The ARN of the user access logging settings that is associated with the web portal.

$sel:userSettingsArn:Portal', portal_userSettingsArn - The ARN of the user settings that is associated with the web portal.

portal_browserSettingsArn :: Lens' Portal (Maybe Text)

The ARN of the browser settings that is associated with this web portal.

portal_browserType :: Lens' Portal (Maybe BrowserType)

The browser that users see when using a streaming session.

portal_creationDate :: Lens' Portal (Maybe UTCTime)

The creation date of the web portal.

portal_displayName :: Lens' Portal (Maybe Text)

The name of the web portal.

portal_networkSettingsArn :: Lens' Portal (Maybe Text)

The ARN of the network settings that is associated with the web portal.

portal_portalArn :: Lens' Portal (Maybe Text)

The ARN of the web portal.

portal_portalEndpoint :: Lens' Portal (Maybe Text)

The endpoint URL of the web portal that users access in order to start streaming sessions.

portal_portalStatus :: Lens' Portal (Maybe PortalStatus)

The status of the web portal.

portal_rendererType :: Lens' Portal (Maybe RendererType)

The renderer that is used in streaming sessions.

portal_statusReason :: Lens' Portal (Maybe Text)

A message that explains why the web portal is in its current status.

portal_trustStoreArn :: Lens' Portal (Maybe Text)

The ARN of the trust store that is associated with the web portal.

portal_userAccessLoggingSettingsArn :: Lens' Portal (Maybe Text)

The ARN of the user access logging settings that is associated with the web portal.

portal_userSettingsArn :: Lens' Portal (Maybe Text)

The ARN of the user settings that is associated with the web portal.