portals

Creates, updates, deletes or gets a portal resource or lists portals in a region

Overview

Name	portals
Type	Resource
Description	Definition of AWS::WorkSpacesWeb::Portal Resource Type
Id	aws.workspacesweb.portals

Fields

Name	Datatype	Description
additional_encryption_context	object
authentication_type	string
browser_settings_arn	string
browser_type	string
creation_date	string
customer_managed_key	string
display_name	string
instance_type	string
ip_access_settings_arn	string
max_concurrent_sessions	number
network_settings_arn	string
portal_arn	string
portal_endpoint	string
portal_status	string
renderer_type	string
service_provider_saml_metadata	string
status_reason	string
tags	array
trust_store_arn	string
user_access_logging_settings_arn	string
user_settings_arn	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all portals in a region.

SELECT
region,
additional_encryption_context,
authentication_type,
browser_settings_arn,
browser_type,
creation_date,
customer_managed_key,
display_name,
instance_type,
ip_access_settings_arn,
max_concurrent_sessions,
network_settings_arn,
portal_arn,
portal_endpoint,
portal_status,
renderer_type,
service_provider_saml_metadata,
status_reason,
tags,
trust_store_arn,
user_access_logging_settings_arn,
user_settings_arn
FROM aws.workspacesweb.portals
WHERE region = 'us-east-1';

Gets all properties from an individual portal.

SELECT
region,
additional_encryption_context,
authentication_type,
browser_settings_arn,
browser_type,
creation_date,
customer_managed_key,
display_name,
instance_type,
ip_access_settings_arn,
max_concurrent_sessions,
network_settings_arn,
portal_arn,
portal_endpoint,
portal_status,
renderer_type,
service_provider_saml_metadata,
status_reason,
tags,
trust_store_arn,
user_access_logging_settings_arn,
user_settings_arn
FROM aws.workspacesweb.portals
WHERE region = 'us-east-1' AND data__Identifier = '<PortalArn>';

INSERT example

Use the following StackQL query and manifest file to create a new portal resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.workspacesweb.portals (
 AdditionalEncryptionContext,
 AuthenticationType,
 BrowserSettingsArn,
 CustomerManagedKey,
 DisplayName,
 InstanceType,
 IpAccessSettingsArn,
 MaxConcurrentSessions,
 NetworkSettingsArn,
 Tags,
 TrustStoreArn,
 UserAccessLoggingSettingsArn,
 UserSettingsArn,
 region
)
SELECT 
'{{ AdditionalEncryptionContext }}',
 '{{ AuthenticationType }}',
 '{{ BrowserSettingsArn }}',
 '{{ CustomerManagedKey }}',
 '{{ DisplayName }}',
 '{{ InstanceType }}',
 '{{ IpAccessSettingsArn }}',
 '{{ MaxConcurrentSessions }}',
 '{{ NetworkSettingsArn }}',
 '{{ Tags }}',
 '{{ TrustStoreArn }}',
 '{{ UserAccessLoggingSettingsArn }}',
 '{{ UserSettingsArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.workspacesweb.portals (
 AdditionalEncryptionContext,
 AuthenticationType,
 BrowserSettingsArn,
 CustomerManagedKey,
 DisplayName,
 InstanceType,
 IpAccessSettingsArn,
 MaxConcurrentSessions,
 NetworkSettingsArn,
 Tags,
 TrustStoreArn,
 UserAccessLoggingSettingsArn,
 UserSettingsArn,
 region
)
SELECT 
 '{{ AdditionalEncryptionContext }}',
 '{{ AuthenticationType }}',
 '{{ BrowserSettingsArn }}',
 '{{ CustomerManagedKey }}',
 '{{ DisplayName }}',
 '{{ InstanceType }}',
 '{{ IpAccessSettingsArn }}',
 '{{ MaxConcurrentSessions }}',
 '{{ NetworkSettingsArn }}',
 '{{ Tags }}',
 '{{ TrustStoreArn }}',
 '{{ UserAccessLoggingSettingsArn }}',
 '{{ UserSettingsArn }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: portal
    props:
      - name: AdditionalEncryptionContext
        value: {}
      - name: AuthenticationType
        value: '{{ AuthenticationType }}'
      - name: BrowserSettingsArn
        value: '{{ BrowserSettingsArn }}'
      - name: CustomerManagedKey
        value: '{{ CustomerManagedKey }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: InstanceType
        value: '{{ InstanceType }}'
      - name: IpAccessSettingsArn
        value: '{{ IpAccessSettingsArn }}'
      - name: MaxConcurrentSessions
        value: null
      - name: NetworkSettingsArn
        value: '{{ NetworkSettingsArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: TrustStoreArn
        value: '{{ TrustStoreArn }}'
      - name: UserAccessLoggingSettingsArn
        value: '{{ UserAccessLoggingSettingsArn }}'
      - name: UserSettingsArn
        value: '{{ UserSettingsArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.workspacesweb.portals
WHERE data__Identifier = '<PortalArn>'
AND region = 'us-east-1';

Permissions

To operate on the portals resource, the following permissions are required:

Create

workspaces-web:CreatePortal,
workspaces-web:GetPortal,
workspaces-web:GetPortalServiceProviderMetadata,
workspaces-web:AssociateBrowserSettings,
workspaces-web:AssociateIpAccessSettings,
workspaces-web:AssociateNetworkSettings,
workspaces-web:AssociateTrustStore,
workspaces-web:AssociateUserAccessLoggingSettings,
workspaces-web:AssociateUserSettings,
workspaces-web:ListTagsForResource,
workspaces-web:TagResource,
kms:CreateGrant,
kms:GenerateDataKey,
kms:Decrypt,
ec2:CreateNetworkInterface,
ec2:CreateNetworkInterfacePermission,
ec2:DeleteNetworkInterface,
ec2:DeleteNetworkInterfacePermission,
ec2:ModifyNetworkInterfaceAttribute,
kinesis:PutRecord,
kinesis:PutRecords,
kinesis:DescribeStreamSummary,
sso:CreateManagedApplicationInstance,
sso:DescribeRegisteredRegions

Read

workspaces-web:GetPortal,
workspaces-web:GetPortalServiceProviderMetadata,
workspaces-web:ListTagsForResource,
kms:Decrypt

Update

workspaces-web:GetPortal,
workspaces-web:GetPortalServiceProviderMetadata,
workspaces-web:UpdatePortal,
workspaces-web:AssociateBrowserSettings,
workspaces-web:AssociateIpAccessSettings,
workspaces-web:AssociateNetworkSettings,
workspaces-web:AssociateTrustStore,
workspaces-web:AssociateUserAccessLoggingSettings,
workspaces-web:AssociateUserSettings,
workspaces-web:DisassociateBrowserSettings,
workspaces-web:DisassociateIpAccessSettings,
workspaces-web:DisassociateNetworkSettings,
workspaces-web:DisassociateTrustStore,
workspaces-web:DisassociateUserAccessLoggingSettings,
workspaces-web:DisassociateUserSettings,
workspaces-web:ListTagsForResource,
workspaces-web:TagResource,
workspaces-web:UntagResource,
kms:CreateGrant,
kms:Encrypt,
kms:GenerateDataKey,
kms:Decrypt,
ec2:CreateNetworkInterface,
ec2:CreateNetworkInterfacePermission,
ec2:DeleteNetworkInterface,
ec2:DeleteNetworkInterfacePermission,
ec2:ModifyNetworkInterfaceAttribute,
kinesis:PutRecord,
kinesis:PutRecords,
kinesis:DescribeStreamSummary,
sso:CreateManagedApplicationInstance,
sso:DeleteManagedApplicationInstance,
sso:DescribeRegisteredRegions,
sso:GetApplicationInstance,
sso:ListApplicationInstances

Delete

workspaces-web:GetPortal,
workspaces-web:DeletePortal,
workspaces-web:DisassociateBrowserSettings,
workspaces-web:DisassociateIpAccessSettings,
workspaces-web:DisassociateNetworkSettings,
workspaces-web:DisassociateTrustStore,
workspaces-web:DisassociateUserAccessLoggingSettings,
workspaces-web:DisassociateUserSettings,
kms:Decrypt,
sso:DeleteManagedApplicationInstance

List

workspaces-web:ListPortals,
kms:Decrypt