PortalArgs

data class PortalArgs(val alarms: Output<AlarmsPropertiesArgs>? = null, val notificationSenderEmail: Output<String>? = null, val portalAuthMode: Output<String>? = null, val portalContactEmail: Output<String>? = null, val portalDescription: Output<String>? = null, val portalName: Output<String>? = null, val portalType: Output<PortalType>? = null, val portalTypeConfiguration: Output<Map<String, PortalTypeEntryArgs>>? = null, val roleArn: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<PortalArgs>

Resource schema for AWS::IoTSiteWise::Portal

Constructors

Link copied to clipboard
constructor(alarms: Output<AlarmsPropertiesArgs>? = null, notificationSenderEmail: Output<String>? = null, portalAuthMode: Output<String>? = null, portalContactEmail: Output<String>? = null, portalDescription: Output<String>? = null, portalName: Output<String>? = null, portalType: Output<PortalType>? = null, portalTypeConfiguration: Output<Map<String, PortalTypeEntryArgs>>? = null, roleArn: Output<String>? = null, tags: Output<List<TagArgs>>? = null)

Properties

Link copied to clipboard
val alarms: Output<AlarmsPropertiesArgs>? = 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: Output<String>? = null

The email address that sends alarm notifications.

Link copied to clipboard
val portalAuthMode: Output<String>? = null

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.

Link copied to clipboard
val portalContactEmail: Output<String>? = null

The AWS administrator's contact email address.

Link copied to clipboard
val portalDescription: Output<String>? = null

A description for the portal.

Link copied to clipboard
val portalName: Output<String>? = null

A friendly name for the portal.

Link copied to clipboard
val portalType: Output<PortalType>? = null

The type of portal

Link copied to clipboard
Link copied to clipboard
val roleArn: Output<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: Output<List<TagArgs>>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): PortalArgs