class Aws::IoTSiteWise::Types::CreatePortalRequest

@note When making an API call, you may pass CreatePortalRequest

data as a hash:

    {
      portal_name: "Name", # required
      portal_description: "Description",
      portal_contact_email: "Email", # required
      client_token: "ClientToken",
      portal_logo_image_file: {
        data: "data", # required
        type: "PNG", # required, accepts PNG
      },
      role_arn: "ARN", # required
      tags: {
        "TagKey" => "TagValue",
      },
      portal_auth_mode: "IAM", # accepts IAM, SSO
      notification_sender_email: "Email",
      alarms: {
        alarm_role_arn: "ARN", # required
        notification_lambda_arn: "ARN",
      },
    }

@!attribute [rw] portal_name

A friendly name for the portal.
@return [String]

@!attribute [rw] portal_description

A description for the portal.
@return [String]

@!attribute [rw] portal_contact_email

The Amazon Web Services administrator's contact email address.
@return [String]

@!attribute [rw] client_token

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.

**A suitable default value is auto-generated.** You should normally
not need to pass this option.
@return [String]

@!attribute [rw] portal_logo_image_file

A logo image to display in the portal. Upload a square,
high-resolution image. The image is displayed on a dark background.
@return [Types::ImageFile]

@!attribute [rw] role_arn

The [ARN][1] 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][2]
in the *IoT SiteWise User Guide*.

[1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
[2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html
@return [String]

@!attribute [rw] tags

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

[1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
@return [Hash<String,String>]

@!attribute [rw] portal_auth_mode

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][1] 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. This option is
  only available in the China Regions.

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

Default: `SSO`

[1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso
@return [String]

@!attribute [rw] notification_sender_email

The email address that sends alarm notifications.

If you use the [IoT Events managed Lambda function][1] to manage
your emails, you must [verify the sender email address in Amazon
SES][2].

[1]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html
[2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
@return [String]

@!attribute [rw] alarms

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][1] in the *IoT SiteWise Application Guide*.

[1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
@return [Types::Alarms]

Constants

SENSITIVE