portal
Gets an individual portal resource
Overview
| Name | portal |
| Type | Resource |
| Description | portal |
| Id | awscc.workspacesweb.portal |
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 | |
ip_access_settings_arn | string | |
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
Currently only SELECT is supported for this resource resource.
Example
SELECT
region,
additional_encryption_context,
authentication_type,
browser_settings_arn,
browser_type,
creation_date,
customer_managed_key,
display_name,
ip_access_settings_arn,
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 awscc.workspacesweb.portal
WHERE data__Identifier = '<PortalArn>';
Permissions
To operate on the portal resource, the following permissions are required:
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