AWS::IoTSiteWise::Portal - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::IoTSiteWise::Portal

Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.

Note

Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTSiteWise::Portal",
  "Properties" : {
      "Alarms" : Alarms,
      "NotificationSenderEmail" : String,
      "PortalAuthMode" : String,
      "PortalContactEmail" : String,
      "PortalDescription" : String,
      "PortalName" : String,
      "PortalType" : String,
      "PortalTypeConfiguration" : {Key: Value, ...},
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoTSiteWise::Portal
Properties:
  Alarms: 
    Alarms
  NotificationSenderEmail: String
  PortalAuthMode: String
  PortalContactEmail: String
  PortalDescription: String
  PortalName: String
  PortalType: String
  PortalTypeConfiguration: 
    Key: Value
  RoleArn: String
  Tags: 
    - Tag

Properties

Alarms

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. For more information, see Monitoring with alarms in the AWS IoT SiteWise Application Guide.

Required: No

Type: Alarms

Update requires: No interruption

NotificationSenderEmail

The email address that sends alarm notifications.

Important

If you use the AWS IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

Required: No

Type: String

Update requires: No interruption

PortalAuthMode

The service to use to authenticate users to the portal. Choose from the following options:

  • SSO – The portal uses AWS IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions.

  • IAM – The portal uses AWS Identity and Access Management to authenticate users and manage user permissions.

You can't change this value after you create a portal.

Default: SSO

Required: No

Type: String

Update requires: Replacement

PortalContactEmail

The AWS administrator's contact email address.

Required: Yes

Type: String

Update requires: No interruption

PortalDescription

A description for the portal.

Required: No

Type: String

Update requires: No interruption

PortalName

A friendly name for the portal.

Required: Yes

Type: String

Update requires: No interruption

PortalType

Define the type of portal. The value for AWS IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for AWS IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

Required: No

Type: String

Allowed values: SITEWISE_PORTAL_V1 | SITEWISE_PORTAL_V2

Update requires: Replacement

PortalTypeConfiguration

Property description not available.

Required: No

Type: Object of PortalTypeEntry

Update requires: No interruption

RoleArn

The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

Required: Yes

Type: String

Update requires: No interruption

Tags

A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the PortalId.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

PortalArn

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

For more information about using the Ref function, see Ref.

PortalClientId

The IAM Identity Center application generated client ID (used with IAM Identity Center APIs).

For more information about using the Ref function, see Ref.

PortalId

The ID of the created portal.

For more information about using the Ref function, see Ref.

PortalStartUrl

The public URL for the AWS IoT SiteWise Monitor portal.

For more information about using the Ref function, see Ref.