pulumi-aws-native-kotlin/com.pulumi.awsnative.iotsitewise.kotlin.outputs/GetPortalResult

GetPortalResult

data class GetPortalResult(val alarms: AlarmsProperties? = null, val notificationSenderEmail: String? = null, val portalArn: String? = null, val portalClientId: String? = null, val portalContactEmail: String? = null, val portalDescription: String? = null, val portalId: String? = null, val portalName: String? = null, val portalStartUrl: String? = null, val portalTypeConfiguration: Map<String, PortalTypeEntry>? = null, val roleArn: String? = null, val tags: List<Tag>? = null)

Constructors

Link copied to clipboard
constructor(alarms: AlarmsProperties? = null, notificationSenderEmail: String? = null, portalArn: String? = null, portalClientId: String? = null, portalContactEmail: String? = null, portalDescription: String? = null, portalId: String? = null, portalName: String? = null, portalStartUrl: String? = null, portalTypeConfiguration: Map<String, PortalTypeEntry>? = null, roleArn: String? = null, tags: List<Tag>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val alarms: AlarmsProperties? = null

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.

Link copied to clipboard
val notificationSenderEmail: String? = null

The email address that sends alarm notifications.

Link copied to clipboard
val portalArn: String? = null

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

Link copied to clipboard
val portalClientId: String? = null

The AWS SSO application generated client ID (used with AWS SSO APIs).

Link copied to clipboard
val portalContactEmail: String? = null

The AWS administrator's contact email address.

Link copied to clipboard
val portalDescription: String? = null

A description for the portal.

Link copied to clipboard
val portalId: String? = null

The ID of the portal.

Link copied to clipboard
val portalName: String? = null

A friendly name for the portal.

Link copied to clipboard
val portalStartUrl: String? = null

The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

Link copied to clipboard
Link copied to clipboard
val roleArn: String? = null

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

Link copied to clipboard
val tags: List<Tag>? = null

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