portals

Creates, updates, deletes, gets or lists a portals resource.

Overview

Name	portals
Type	Resource
Id	aws.workspaces_web.portals

Fields

The following fields are returned by SELECT queries:

get_portal

Name	Datatype	Description
additional_encryption_context	object	The additional encryption context of the portal.
authentication_type	string	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 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. (Standard, IAM_Identity_Center)
browser_settings_arn	string	The ARN of the browser settings that is associated with this web portal. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)
browser_type	string	The browser that users see when using a streaming session. (Chrome)
creation_date	string (date-time)	The creation date of the web portal.
customer_managed_key	string	The customer managed key used to encrypt sensitive information in the portal. (pattern: <code>arn:[\w+=/,.@-]+:kms:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:key/[a-zA-Z0-9-]+</code>)
data_protection_settings_arn	string	The ARN of the data protection settings. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)
display_name	string	The name of the web portal. (pattern: <code>.+</code>)
instance_type	string	The type and resources of the underlying instance. (standard.regular, standard.large, standard.xlarge)
ip_access_settings_arn	string	The ARN of the IP access settings. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)
max_concurrent_sessions	integer	The maximum number of concurrent sessions for the portal.
network_settings_arn	string	The ARN of the network settings that is associated with the web portal. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)
portal_arn	string	The ARN of the web portal. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)
portal_custom_domain	string	The custom domain of the web portal that users access in order to start streaming sessions. (pattern: <code>(|[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9]).)+[a-zA-Z0-9]+)</code>)
portal_endpoint	string	The endpoint URL of the web portal that users access in order to start streaming sessions. (pattern: <code>(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]</code>)
portal_status	string	The status of the web portal. (Incomplete, Pending, Active)
renderer_type	string	The renderer that is used in streaming sessions. (AppStream)
session_logger_arn	string	The ARN of the session logger that is assocaited with the portal. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)
status_reason	string	A message that explains why the web portal is in its current status. (pattern: <code>.*</code>)
trust_store_arn	string	The ARN of the trust store that is associated with the web portal. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)
user_access_logging_settings_arn	string	The ARN of the user access logging settings that is associated with the web portal. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)
user_settings_arn	string	The ARN of the user settings that is associated with the web portal. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)

list_portals

Name	Datatype	Description
next_token	string	The pagination token used to retrieve the next page of results for this operation. (pattern: <code>\S+</code>)
portals	array	The portals in the list.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_portal	select	portal_arn, region		Gets the web portal.
list_portals	select	region	nextToken, maxResults	Retrieves a list or web portals.
create_portal	insert	region		Creates a web portal.
update_portal	update	portal_arn, region		Updates a web portal.
delete_portal	delete	portal_arn, region		Deletes a web portal.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
portal_arn	string	The ARN of the web portal.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to be included in the next page.
nextToken	string	The pagination token used to retrieve the next page of results for this operation.

SELECT examples

get_portal

Gets the web portal.

SELECT
additional_encryption_context,
authentication_type,
browser_settings_arn,
browser_type,
creation_date,
customer_managed_key,
data_protection_settings_arn,
display_name,
instance_type,
ip_access_settings_arn,
max_concurrent_sessions,
network_settings_arn,
portal_arn,
portal_custom_domain,
portal_endpoint,
portal_status,
renderer_type,
session_logger_arn,
status_reason,
trust_store_arn,
user_access_logging_settings_arn,
user_settings_arn
FROM aws.workspaces_web.portals
WHERE portal_arn = '{{ portal_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_portals

Retrieves a list or web portals.

SELECT
next_token,
portals
FROM aws.workspaces_web.portals
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_portal

Creates a web portal.

INSERT INTO aws.workspaces_web.portals (
displayName,
tags,
customerManagedKey,
additionalEncryptionContext,
clientToken,
authenticationType,
instanceType,
maxConcurrentSessions,
portalCustomDomain,
region
)
SELECT 
'{{ displayName }}',
'{{ tags }}',
'{{ customerManagedKey }}',
'{{ additionalEncryptionContext }}',
'{{ clientToken }}',
'{{ authenticationType }}',
'{{ instanceType }}',
{{ maxConcurrentSessions }},
'{{ portalCustomDomain }}',
'{{ region }}'
RETURNING
portal_arn,
portal_endpoint
;

Manifest

# Description fields are for documentation purposes
- name: portals
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the portals resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: customerManagedKey
    value: "{{ customerManagedKey }}"
  - name: additionalEncryptionContext
    value: "{{ additionalEncryptionContext }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: authenticationType
    value: "{{ authenticationType }}"
    valid_values: ['Standard', 'IAM_Identity_Center']
  - name: instanceType
    value: "{{ instanceType }}"
    valid_values: ['standard.regular', 'standard.large', 'standard.xlarge']
  - name: maxConcurrentSessions
    value: {{ maxConcurrentSessions }}
  - name: portalCustomDomain
    value: "{{ portalCustomDomain }}"

UPDATE examples

update_portal

Updates a web portal.

UPDATE aws.workspaces_web.portals
SET 
displayName = '{{ displayName }}',
authenticationType = '{{ authenticationType }}',
instanceType = '{{ instanceType }}',
maxConcurrentSessions = {{ maxConcurrentSessions }},
portalCustomDomain = '{{ portalCustomDomain }}'
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
portal;

DELETE examples

delete_portal

Deletes a web portal.

DELETE FROM aws.workspaces_web.portals
WHERE portal_arn = '{{ portal_arn }}' --required
AND region = '{{ region }}' --required
;