Skip to main content

portals

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

Overview​

Nameportals
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::Portal Resource Type
Idawscc.workspacesweb.portals

Fields​

NameDatatypeDescription
additional_encryption_contextobject
authentication_typestring
browser_settings_arnstring
browser_typestring
creation_datestring
customer_managed_keystring
data_protection_settings_arnstring
display_namestring
instance_typestring
ip_access_settings_arnstring
max_concurrent_sessionsnumber
network_settings_arnstring
portal_arnstring
portal_endpointstring
portal_statusstring
renderer_typestring
service_provider_saml_metadatastring
session_logger_arnstring
status_reasonstring
▶tagsarray
trust_store_arnstring
user_access_logging_settings_arnstring
user_settings_arnstring
regionstringAWS region.

For more information, see AWS::WorkSpacesWeb::Portal.

Methods​

NameResourceAccessible byRequired Params
create_resourceportalsINSERTregion
delete_resourceportalsDELETEIdentifier, region
update_resourceportalsUPDATEIdentifier, PatchDocument, region
list_resourcesportals_list_onlySELECTregion
get_resourceportalsSELECTIdentifier, region

SELECT examples​

Gets all properties from an individual portal.

SELECT
  region,
  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_endpoint,
  portal_status,
  renderer_type,
  service_provider_saml_metadata,
  session_logger_arn,
  status_reason,
  tags,
  trust_store_arn,
  user_access_logging_settings_arn,
  user_settings_arn
FROM awscc.workspacesweb.portals
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ portal_arn }}';

INSERT example​

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

/*+ create */
INSERT INTO awscc.workspacesweb.portals (
  AdditionalEncryptionContext,
  AuthenticationType,
  BrowserSettingsArn,
  CustomerManagedKey,
  DataProtectionSettingsArn,
  DisplayName,
  InstanceType,
  IpAccessSettingsArn,
  MaxConcurrentSessions,
  NetworkSettingsArn,
  SessionLoggerArn,
  Tags,
  TrustStoreArn,
  UserAccessLoggingSettingsArn,
  UserSettingsArn,
  region
)
SELECT
  '{{ additional_encryption_context }}',
  '{{ authentication_type }}',
  '{{ browser_settings_arn }}',
  '{{ customer_managed_key }}',
  '{{ data_protection_settings_arn }}',
  '{{ display_name }}',
  '{{ instance_type }}',
  '{{ ip_access_settings_arn }}',
  '{{ max_concurrent_sessions }}',
  '{{ network_settings_arn }}',
  '{{ session_logger_arn }}',
  '{{ tags }}',
  '{{ trust_store_arn }}',
  '{{ user_access_logging_settings_arn }}',
  '{{ user_settings_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

UPDATE example​

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

/*+ update */
UPDATE awscc.workspacesweb.portals
SET PatchDocument = string('{{ {
    "AuthenticationType": authentication_type,
    "BrowserSettingsArn": browser_settings_arn,
    "DataProtectionSettingsArn": data_protection_settings_arn,
    "DisplayName": display_name,
    "InstanceType": instance_type,
    "IpAccessSettingsArn": ip_access_settings_arn,
    "MaxConcurrentSessions": max_concurrent_sessions,
    "NetworkSettingsArn": network_settings_arn,
    "SessionLoggerArn": session_logger_arn,
    "Tags": tags,
    "TrustStoreArn": trust_store_arn,
    "UserAccessLoggingSettingsArn": user_access_logging_settings_arn,
    "UserSettingsArn": user_settings_arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ portal_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example​

/*+ delete */
DELETE FROM awscc.workspacesweb.portals
WHERE
  Identifier = '{{ portal_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters​

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

ParameterDescription
ClientToken
A unique identifier to ensure the idempotency of the resource request.This allows the provider to accurately distinguish between retries and new requests.
A client token is valid for 36 hours once used.
After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
RoleArn
The ARN of the IAM role used to perform this resource operation.The role specified must have the permissions required for this operation.
If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId
For private resource types, the type version to use in this resource operation.If you do not specify a resource version, the default version is used.

Permissions​

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

workspaces-web:CreatePortal,
workspaces-web:GetPortal*,
workspaces-web:AssociateBrowserSettings,
workspaces-web:AssociateIpAccessSettings,
workspaces-web:AssociateNetworkSettings,
workspaces-web:AssociateTrustStore,
workspaces-web:AssociateUserAccessLoggingSettings,
workspaces-web:AssociateUserSettings,
workspaces-web:AssociateDataProtectionSettings,
workspaces-web:AssociateSessionLogger,
workspaces-web:List*,
workspaces-web:TagResource,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt,
kms:GenerateDataKeyWithoutPlaintext,
kms:ReEncryptTo,
kms:ReEncryptFrom,
ec2:CreateNetworkInterface,
ec2:CreateNetworkInterfacePermission,
ec2:DeleteNetworkInterface,
ec2:DeleteNetworkInterfacePermission,
ec2:ModifyNetworkInterfaceAttribute,
kinesis:PutRecord,
kinesis:PutRecords,
kinesis:Describe*,
sso:CreateManagedApplicationInstance,
sso:Describe*,
s3:PutObject