---
type: resource-type
title: IoTSiteWisePortal
description: aws resource type AWS::IoTSiteWise::Portal
name: IoTSiteWisePortal
lexicon: aws
resource_type: AWS::IoTSiteWise::Portal
---
`AWS::IoTSiteWise::Portal`, a resource type of the aws lexicon.

## Properties

- `PortalContactEmail` (`string`, required): The AWS administrator's contact email address.
- `PortalName` (`string`, required): A friendly name for the portal.
- `RoleArn` (`string`, required): The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
- `Alarms` (`Record<string, unknown>`, optional): Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
- `NotificationSenderEmail` (`string`, optional): The email address that sends alarm notifications.
- `PortalArn` (`string`, optional): The ARN of the portal, which has the following format.
- `PortalAuthMode` (`string`, optional): The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
- `PortalClientId` (`string`, optional): The AWS SSO application generated client ID (used with AWS SSO APIs).
- `PortalDescription` (`string`, optional): A description for the portal.
- `PortalId` (`string`, optional): The ID of the portal.
- `PortalStartUrl` (`string`, optional): The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
- `PortalType` (`"SITEWISE_PORTAL_V1" | "SITEWISE_PORTAL_V2"`, optional): The type of portal
- `PortalTypeConfiguration` (`Record<string, unknown>`, optional)
- `Tags` (`IoTSiteWisePortal_Tag[]`, optional): A list of key-value pairs that contain metadata for the portal.

## Attributes

- `PortalArn`
- `PortalClientId`
- `PortalId`
- `PortalStartUrl`