AWS Fundamentals Logo
AWS Fundamentals
AWS::WorkSpacesWeb::Portal

WorkSpacesWeb Portal

Definition of AWS::WorkSpacesWeb::Portal Resource Type

Properties

16 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
AdditionalEncryptionContext
EncryptionContextMap
Create-only
AuthenticationType
string
BrowserSettingsArn
string
CustomerManagedKey
string
Create-only
DataProtectionSettingsArn
string
DisplayName
string
InstanceType
string
IpAccessSettingsArn
string
MaxConcurrentSessions
number
NetworkSettingsArn
string
PortalCustomDomain
string
SessionLoggerArn
string
Tags
Array<Tag>
TrustStoreArn
string
UserAccessLoggingSettingsArn
string
UserSettingsArn
string

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
BrowserTypestring-
CreationDatestring-
PortalArnstring-
PortalEndpointstring-
PortalStatusstring-
RendererTypestring-
ServiceProviderSamlMetadatastring-
StatusReasonstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::WorkSpacesWeb::Portal

Resources:
  MyResource:
    Type: AWS::WorkSpacesWeb::Portal
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

workspaces-web:CreatePortalworkspaces-web:GetPortal*workspaces-web:AssociateBrowserSettingsworkspaces-web:AssociateIpAccessSettingsworkspaces-web:AssociateNetworkSettingsworkspaces-web:AssociateTrustStoreworkspaces-web:AssociateUserAccessLoggingSettingsworkspaces-web:AssociateUserSettings

read

workspaces-web:GetPortal*workspaces-web:List*kms:Decryptkms:DescribeKey

update

workspaces-web:GetPortal*workspaces-web:UpdatePortalworkspaces-web:AssociateBrowserSettingsworkspaces-web:AssociateIpAccessSettingsworkspaces-web:AssociateNetworkSettingsworkspaces-web:AssociateTrustStoreworkspaces-web:AssociateUserAccessLoggingSettingsworkspaces-web:AssociateUserSettings

delete

workspaces-web:GetPortal*workspaces-web:DeletePortalworkspaces-web:DisassociateBrowserSettingsworkspaces-web:DisassociateIpAccessSettingsworkspaces-web:DisassociateNetworkSettingsworkspaces-web:DisassociateTrustStoreworkspaces-web:DisassociateUserAccessLoggingSettingsworkspaces-web:DisassociateUserSettings

list

workspaces-web:List*kms:Decryptkms:DescribeKey

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceWorkSpacesWeb
Properties24
Required0
TaggingSupported
Primary IDPortalArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AdditionalEncryptionContextCustomerManagedKey

Related Resources

External Links