iotsitewise/aws.sdk.kotlin.services.iotsitewise.model/CreatePortalRequest/Builder

Builder

Properties

Contains the configuration information of an alarm created in an 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 IoT SiteWise Application Guide.

clientToken

var clientToken: String?

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

notificationSenderEmail

var notificationSenderEmail: String?

The email address that sends alarm notifications.

portalAuthMode

var portalAuthMode: AuthMode?

The service to use to authenticate users to the portal. Choose from the following options:

portalContactEmail

var portalContactEmail: String?

The Amazon Web Services administrator's contact email address.

portalDescription

var portalDescription: String?

A description for the portal.

portalLogoImageFile

var portalLogoImageFile: ImageFile?

A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

portalName

var portalName: String?

A friendly name for the portal.

roleArn

var roleArn: String?

The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

Functions

alarms

fun alarms(block: Alarms.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.iotsitewise.model.Alarms inside the given block

portalLogoImageFile

fun portalLogoImageFile(block: ImageFile.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.iotsitewise.model.ImageFile inside the given block