AWS::IoTSiteWise::Portal - AWS CloudFormation

AWS::IoTSiteWise::Portal

Creates a portal, which can contain projects and dashboards. Before you can create a portal, you must enable AWS SSO. AWS IoT SiteWise Monitor uses AWS SSO to manage user permissions. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide.

Note

Before you can sign in to a new portal, you must add at least one AWS SSO user or group 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" : Json, "NotificationSenderEmail" : String, "PortalAuthMode" : String, "PortalContactEmail" : String, "PortalDescription" : String, "PortalName" : String, "RoleArn" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::IoTSiteWise::Portal Properties: Alarms: Json NotificationSenderEmail: String PortalAuthMode: String PortalContactEmail: String PortalDescription: String PortalName: String 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: Json

Update requires: No interruption

NotificationSenderEmail

The email address that sends alarm notifications.

Important

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 Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO 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 (IAM) to authenticate users and manage user permissions. This option is only available in China (Beijing).

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

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: List 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 AWS SSO application generated client ID (used with AWS SSO 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.