AWS::IoTSiteWise::Portal

IoTSiteWise Portal

Resource schema for AWS::IoTSiteWise::Portal

Properties

10 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`PortalContactEmail`	`string`	Required
`PortalName`	`string`	Required
`RoleArn`	`string`	Required
`Alarms`	`object`
`NotificationSenderEmail`	`string`
`PortalAuthMode`	`string`	Create-only
`PortalDescription`	`string`
`PortalType`	`string`	Create-only
`PortalTypeConfiguration`	`PortalTypeConfiguration`
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`PortalArn`	`string`	The ARN of the portal, which has the following format.
`PortalClientId`	`string`	The AWS SSO application generated client ID (used with AWS SSO APIs).
`PortalId`	`string`	The ID of the portal.
`PortalStartUrl`	`string`	The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::IoTSiteWise::Portal

Resources:
  MyResource:
    Type: AWS::IoTSiteWise::Portal
    Properties:
      PortalContactEmail: "value"
      PortalName: "my-portalname"
      RoleArn: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iotsitewise:CreatePortaliotsitewise:DescribePortaliotsitewise:ListTagsForResourceiotsitewise:TagResourceiam:PassRolesso:CreateManagedApplicationInstancesso:DescribeRegisteredRegions

read

iotsitewise:DescribePortaliotsitewise:ListTagsForResource

update

iotsitewise:DescribePortaliotsitewise:ListTagsForResourceiotsitewise:TagResourceiotsitewise:UpdatePortaliotsitewise:UntagResourceiam:PassRolesso:GetManagedApplicationInstancesso:UpdateApplicationInstanceDisplayData

delete

iotsitewise:DescribePortaliotsitewise:DeletePortalsso:DeleteManagedApplicationInstance

list

iotsitewise:ListPortalsiotsitewise:ListTagsForResource

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceIoTSiteWise

Properties14

Required3

TaggingSupported

Primary IDPortalId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

PortalAuthModePortalType

Related Resources

External Links

AWS Documentation