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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#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)


1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1533

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode)
  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 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)


1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1533

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

#portal_contact_emailString

The AWS administrator's contact email address.

Returns:

  • (String)


1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1533

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

#portal_descriptionString

A description for the portal.

Returns:

  • (String)


1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1533

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode)
  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:



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1533

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

#portal_nameString

A friendly name for the portal.

Returns:

  • (String)


1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1533

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

#role_arnString

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)


1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1533

class CreatePortalRequest < Struct.new(
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :client_token,
  :portal_logo_image_file,
  :role_arn,
  :tags,
  :portal_auth_mode)
  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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Returns:

  • (Hash<String,String>)


1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1533

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