AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

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",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarmsTypes::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 in the IoT SiteWise Application Guide.

Returns:



2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2090

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

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.

Returns:

  • (String)


2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2090

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#notification_sender_emailString

The email address that sends alarm notifications.

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

Returns:

  • (String)


2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2090

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_auth_modeString

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

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

Default: SSO

Returns:

  • (String)


2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2090

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_contact_emailString

The Amazon Web Services administrator's contact email address.

Returns:

  • (String)


2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2090

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_descriptionString

A description for the portal.

Returns:

  • (String)


2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2090

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_logo_image_fileTypes::ImageFile

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

Returns:



2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2090

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_nameString

A friendly name for the portal.

Returns:

  • (String)


2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2090

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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.

Returns:

  • (String)


2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2090

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

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.

Returns:

  • (Hash<String,String>)


2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2090

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end