You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTSiteWise::Types::CreatePortalRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreatePortalRequest as input to an Aws::Client method, you can use a vanilla 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
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ 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.

Returns:

  • (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.

#portal_auth_mode ⇒ String

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

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

  • IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. This option is only available in the China Regions.

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

Default: SSO

Returns:

  • (String) —

    The service to use to authenticate users to the portal.

#portal_contact_email ⇒ String

The AWS administrator\'s contact email address.

Returns:

  • (String) —

    The AWS administrator\'s contact email address.

#portal_description ⇒ String

A description for the portal.

Returns:

  • (String) —

    A description for the portal.

#portal_logo_image_file ⇒ Types::ImageFile

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

Returns:

#portal_name ⇒ String

A friendly name for the portal.

Returns:

  • (String) —

    A friendly name for the portal.

#role_arn ⇒ String

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

Returns:

  • (String) —

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

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) —

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