Class: Aws::IoTSiteWise::Types::CreatePortalRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTSiteWise::Types::CreatePortalRequest
- Defined in:
- gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#alarms ⇒ Types::Alarms
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
-
#client_token ⇒ String
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
-
#notification_sender_email ⇒ String
The email address that sends alarm notifications.
-
#portal_auth_mode ⇒ String
The service to use to authenticate users to the portal.
-
#portal_contact_email ⇒ String
The Amazon Web Services administrator's contact email address.
-
#portal_description ⇒ String
A description for the portal.
-
#portal_logo_image_file ⇒ Types::ImageFile
A logo image to display in the portal.
-
#portal_name ⇒ String
A friendly name for the portal.
-
#role_arn ⇒ String
The [ARN][1] of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf.
-
#tags ⇒ Hash<String,String>
A list of key-value pairs that contain metadata for the portal.
Instance Attribute Details
#alarms ⇒ Types::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.
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3219 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_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.
A suitable default value is auto-generated. You should normally not need to pass this option.
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3219 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_email ⇒ String
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.
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3219 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_mode ⇒ String
The service to use to authenticate users to the portal. Choose from the following options:
SSO
– The portal uses IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center 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
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3219 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_email ⇒ String
The Amazon Web Services administrator's contact email address.
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3219 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_description ⇒ String
A description for the portal.
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3219 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_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.
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3219 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_name ⇒ String
A friendly name for the portal.
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3219 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_arn ⇒ 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.
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3219 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 |
#tags ⇒ Hash<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.
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3219 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 |