CreatePortalRequest

import type { CreatePortalRequest } from "https://aws-api.deno.dev/v0.3/services/iotsitewise.ts?docs=full";

interface CreatePortalRequest {

alarms?: Alarms | null;

clientToken?: string | null;

notificationSenderEmail?: string | null;

portalAuthMode?: AuthMode | null;

portalContactEmail: string;

portalDescription?: string | null;

portalLogoImageFile?: ImageFile | null;

portalName: string;

roleArn: string;

tags?: {

[key: string]: string | null | undefined;

} | null;

}

§Properties

alarms?: Alarms | null

[src]

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?: string | null

[src]

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?: string | null

[src]

The email address that sends alarm notifications.

! IMPORTANT: ! If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

portalAuthMode?: AuthMode | null

[src]

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

SSO – The portal uses Amazon Web Services Single Sign On to authenticate users and manage user permissions. Before you can create a portal that uses Amazon Web Services SSO, you must enable Amazon Web Services SSO. For more information, see Enabling Amazon Web Services SSO in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions.
IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions.

You can't change this value after you create a portal.

Default: SSO

portalContactEmail: string

[src]

The Amazon Web Services administrator's contact email address.

portalDescription?: string | null

[src]

A description for the portal.

portalLogoImageFile?: ImageFile | null

[src]

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

portalName: string

[src]

A friendly name for the portal.

roleArn: string

[src]

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.

tags?: {

[key: string]: string | null | undefined;

} | null

[src]

A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.