Class: Aws::WorkSpacesWeb::Types::PortalSummary

Inherits:

Struct

• Object
• Struct
• Aws::WorkSpacesWeb::Types::PortalSummary

Includes:

Structure

Defined in:

lib/aws-sdk-workspacesweb/types.rb

Overview

The summary of the portal.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:display_name]

Instance Attribute Summary

• #authentication_type ⇒ String

  The type of authentication integration points used when signing into the web portal.

• #browser_settings_arn ⇒ String

  The ARN of the browser settings that is associated with the web portal.

• #browser_type ⇒ String

  The browser type of the web portal.

• #creation_date ⇒ Time

  The creation date of the web portal.

• #display_name ⇒ String

  The name of the web portal.

• #instance_type ⇒ String

  The type and resources of the underlying instance.

• #ip_access_settings_arn ⇒ String

  The ARN of the IP access settings.

• #max_concurrent_sessions ⇒ Integer

  The maximum number of concurrent sessions for the portal.

• #network_settings_arn ⇒ String

  The ARN of the network settings that is associated with the web portal.

• #portal_arn ⇒ String

  The ARN of the web portal.

• #portal_endpoint ⇒ String

  The endpoint URL of the web portal that users access in order to start streaming sessions.

• #portal_status ⇒ String

  The status of the web portal.

• #renderer_type ⇒ String

  The renderer that is used in streaming sessions.

• #trust_store_arn ⇒ String

  The ARN of the trust that is associated with this web portal.

• #user_access_logging_settings_arn ⇒ String

  The ARN of the user access logging settings that is associated with the web portal.

• #user_settings_arn ⇒ String

  The ARN of the user settings that is associated with the web portal.

Instance Attribute Details

#authentication_type ⇒ String

The type of authentication integration points used when signing into the web portal. Defaults to ‘Standard`.

‘Standard` web portals are authenticated directly through your identity provider. You need to call `CreateIdentityProvider` to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

‘IAM Identity Center` web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#browser_settings_arn ⇒ String

The ARN of the browser settings that is associated with the web portal.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#browser_type ⇒ String

The browser type of the web portal.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#creation_date ⇒ Time

The creation date of the web portal.

Returns:

• (Time)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#display_name ⇒ String

The name of the web portal.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#instance_type ⇒ String

The type and resources of the underlying instance.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#ip_access_settings_arn ⇒ String

The ARN of the IP access settings.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#max_concurrent_sessions ⇒ Integer

The maximum number of concurrent sessions for the portal.

Returns:

• (Integer)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#network_settings_arn ⇒ String

The ARN of the network settings that is associated with the web portal.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#portal_arn ⇒ String

The ARN of the web portal.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#portal_endpoint ⇒ String

The endpoint URL of the web portal that users access in order to start streaming sessions.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#portal_status ⇒ String

The status of the web portal.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#renderer_type ⇒ String

The renderer that is used in streaming sessions.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#trust_store_arn ⇒ String

The ARN of the trust that is associated with this web portal.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#user_access_logging_settings_arn ⇒ String

The ARN of the user access logging settings that is associated with the web portal.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#user_settings_arn ⇒ String

The ARN of the user settings that is associated with the web portal.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 2360

class PortalSummary < Struct.new(
  :authentication_type,
  :browser_settings_arn,
  :browser_type,
  :creation_date,
  :display_name,
  :instance_type,
  :ip_access_settings_arn,
  :max_concurrent_sessions,
  :network_settings_arn,
  :portal_arn,
  :portal_endpoint,
  :portal_status,
  :renderer_type,
  :trust_store_arn,
  :user_access_logging_settings_arn,
  :user_settings_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end