Portal

The web portal.

portalArn

The ARN of the web portal.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+

Required: Yes

additionalEncryptionContext

The additional encryption context of the portal.

Type: String to string map

Key Length Constraints: Minimum length of 0. Maximum length of 131072.

Key Pattern: [\s\S]*

Value Length Constraints: Minimum length of 0. Maximum length of 131072.

Value Pattern: [\s\S]*

Required: No

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. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

Type: String

Valid Values: Standard | IAM_Identity_Center

Required: No

browserSettingsArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+

Required: No

browserType

The browser that users see when using a streaming session.

Type: String

Valid Values: Chrome

Required: No

creationDate

The creation date of the web portal.

Type: Timestamp

Required: No

customerManagedKey

The customer managed key used to encrypt sensitive information in the portal.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+

Required: No

dataProtectionSettingsArn

The ARN of the data protection settings.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+

Required: No

displayName

The name of the web portal.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: .+

Required: No

instanceType

The type and resources of the underlying instance.

Type: String

Valid Values: standard.regular | standard.large | standard.xlarge

Required: No

ipAccessSettingsArn

The ARN of the IP access settings.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+

Required: No

maxConcurrentSessions

The maximum number of concurrent sessions for the portal.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5000.

Required: No

networkSettingsArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+

Required: No

portalEndpoint

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 253.

Pattern: [a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\.)+[a-zA-Z0-9]+

Required: No

portalStatus

The status of the web portal.

Type: String

Valid Values: Incomplete | Pending | Active

Required: No

rendererType

The renderer that is used in streaming sessions.

Type: String

Valid Values: AppStream

Required: No

sessionLoggerArn

The ARN of the session logger that is assocaited with the portal.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+

Required: No

statusReason

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*

Required: No

trustStoreArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+

Required: No

userAccessLoggingSettingsArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+

Required: No

userSettingsArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+

Required: No

Portal

Contents

See Also