Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-iotsitewise-portal.json
Parent schema serverless-framework-configuration
Type: object

Properties

PortalContactEmail string | Aws_CF_FunctionString required

The AWS administrator's contact email address.

PortalName string | Aws_CF_FunctionString required

A friendly name for the portal.

RoleArn string | Aws_CF_FunctionString required

The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.

PortalAuthMode string | Aws_CF_FunctionString

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.

PortalDescription string | Aws_CF_FunctionString

A description for the portal.

NotificationSenderEmail string | Aws_CF_FunctionString

The email address that sends alarm notifications.

Alarms object

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.

2 nested properties
AlarmRoleArn string | Aws_CF_FunctionString

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.

NotificationLambdaArn string | Aws_CF_FunctionString

The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.

Tags Tag[]

A list of key-value pairs that contain metadata for the portal.

Definitions

Tag object

To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted.

Key string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required