PortalArgs

data class PortalArgs(val additionalEncryptionContext: Output<Map<String, String>>? = null, val authenticationType: Output<PortalAuthenticationType>? = null, val browserSettingsArn: Output<String>? = null, val customerManagedKey: Output<String>? = null, val dataProtectionSettingsArn: Output<String>? = null, val displayName: Output<String>? = null, val instanceType: Output<PortalInstanceType>? = null, val ipAccessSettingsArn: Output<String>? = null, val maxConcurrentSessions: Output<Double>? = null, val networkSettingsArn: Output<String>? = null, val tags: Output<List<TagArgs>>? = null, val trustStoreArn: Output<String>? = null, val userAccessLoggingSettingsArn: Output<String>? = null, val userSettingsArn: Output<String>? = null) : ConvertibleToJava<PortalArgs>

Definition of AWS::WorkSpacesWeb::Portal Resource Type

Constructors

Link copied to clipboard
constructor(additionalEncryptionContext: Output<Map<String, String>>? = null, authenticationType: Output<PortalAuthenticationType>? = null, browserSettingsArn: Output<String>? = null, customerManagedKey: Output<String>? = null, dataProtectionSettingsArn: Output<String>? = null, displayName: Output<String>? = null, instanceType: Output<PortalInstanceType>? = null, ipAccessSettingsArn: Output<String>? = null, maxConcurrentSessions: Output<Double>? = null, networkSettingsArn: Output<String>? = null, tags: Output<List<TagArgs>>? = null, trustStoreArn: Output<String>? = null, userAccessLoggingSettingsArn: Output<String>? = null, userSettingsArn: Output<String>? = null)

Properties

Link copied to clipboard

The additional encryption context of the portal.

Link copied to clipboard

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 (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Secure Browser’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps:

Link copied to clipboard
val browserSettingsArn: Output<String>? = null

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

Link copied to clipboard
val customerManagedKey: Output<String>? = null

The customer managed key of the web portal. Pattern : ^arn:[\w+=\/,&#46;@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$

Link copied to clipboard
val dataProtectionSettingsArn: Output<String>? = null

The ARN of the data protection settings.

Link copied to clipboard
val displayName: Output<String>? = null

The name of the web portal.

Link copied to clipboard
val instanceType: Output<PortalInstanceType>? = null

The type and resources of the underlying instance.

Link copied to clipboard
val ipAccessSettingsArn: Output<String>? = null

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

Link copied to clipboard
val maxConcurrentSessions: Output<Double>? = null

The maximum number of concurrent sessions for the portal.

Link copied to clipboard
val networkSettingsArn: Output<String>? = null

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

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

The tags to add to the web portal. A tag is a key-value pair.

Link copied to clipboard
val trustStoreArn: Output<String>? = null

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

Link copied to clipboard

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

Link copied to clipboard
val userSettingsArn: Output<String>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): PortalArgs