Class: Aws::WorkSpacesWeb::Types::Portal

Inherits:

Struct

• Object
• Struct
• Aws::WorkSpacesWeb::Types::Portal

Defined in:

gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb

Overview

The web portal.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:display_name]

Instance Attribute Summary

• #additional_encryption_context ⇒ Hash<String,String>

  The additional encryption context of the portal.

• #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 this web portal.

• #browser_type ⇒ String

  The browser that users see when using a streaming session.

• #creation_date ⇒ Time

  The creation date of the web portal.

• #customer_managed_key ⇒ String

  The customer managed key used to encrypt sensitive information in the portal.

• #data_protection_settings_arn ⇒ String

  The ARN of the data protection settings.

• #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_custom_domain ⇒ String

  The custom domain of the web portal that users access in order to start streaming sessions.

• #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.

• #session_logger_arn ⇒ String

  The ARN of the session logger that is assocaited with the portal.

• #status_reason ⇒ String

  A message that explains why the web portal is in its current status.

• #trust_store_arn ⇒ String

  The ARN of the trust store that is associated with the 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

#additional_encryption_context ⇒ Hash<String,String>

The additional encryption context of the portal.

Returns:

• (Hash<String,String>)

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

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

#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. 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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3320

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

#browser_settings_arn ⇒ String

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

Returns:

• (String)

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

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

#browser_type ⇒ String

The browser that users see when using a streaming session.

Returns:

• (String)

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

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

#creation_date ⇒ Time

The creation date of the web portal.

Returns:

• (Time)

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

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

#customer_managed_key ⇒ String

The customer managed key used to encrypt sensitive information in the portal.

Returns:

• (String)

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

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

#data_protection_settings_arn ⇒ String

The ARN of the data protection settings.

Returns:

• (String)

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

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

#display_name ⇒ String

The name of the web portal.

Returns:

• (String)

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

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

#instance_type ⇒ String

The type and resources of the underlying instance.

Returns:

• (String)

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

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

#ip_access_settings_arn ⇒ String

The ARN of the IP access settings.

Returns:

• (String)

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

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

#max_concurrent_sessions ⇒ Integer

The maximum number of concurrent sessions for the portal.

Returns:

• (Integer)

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

class Portal < Struct.new(
  :portal_arn,
  :renderer_type,
  :browser_type,
  :portal_status,
  :portal_endpoint,
  :display_name,
  :creation_date,
  :browser_settings_arn,
  :data_protection_settings_arn,
  :user_settings_arn,
  :network_settings_arn,
  :session_logger_arn,
  :trust_store_arn,
  :status_reason,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :customer_managed_key,
  :additional_encryption_context,
  :instance_type,
  :max_concurrent_sessions,
  :portal_custom_domain)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3320

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

#portal_arn ⇒ String

The ARN of the web portal.

Returns:

• (String)

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

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

#portal_custom_domain ⇒ String

The custom domain of the web portal that users access in order to start streaming sessions.

Returns:

• (String)

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

class Portal < Struct.new(
  :portal_arn,
  :renderer_type,
  :browser_type,
  :portal_status,
  :portal_endpoint,
  :display_name,
  :creation_date,
  :browser_settings_arn,
  :data_protection_settings_arn,
  :user_settings_arn,
  :network_settings_arn,
  :session_logger_arn,
  :trust_store_arn,
  :status_reason,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :customer_managed_key,
  :additional_encryption_context,
  :instance_type,
  :max_concurrent_sessions,
  :portal_custom_domain)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3320

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

#portal_status ⇒ String

The status of the web portal.

Returns:

• (String)

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

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

#renderer_type ⇒ String

The renderer that is used in streaming sessions.

Returns:

• (String)

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

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

#session_logger_arn ⇒ String

The ARN of the session logger that is assocaited with the portal.

Returns:

• (String)

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

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

#status_reason ⇒ String

A message that explains why the web portal is in its current status.

Returns:

• (String)

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

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

#trust_store_arn ⇒ String

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

Returns:

• (String)

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

class Portal < Struct.new(
  :portal_arn,
  :renderer_type,
  :browser_type,
  :portal_status,
  :portal_endpoint,
  :display_name,
  :creation_date,
  :browser_settings_arn,
  :data_protection_settings_arn,
  :user_settings_arn,
  :network_settings_arn,
  :session_logger_arn,
  :trust_store_arn,
  :status_reason,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :customer_managed_key,
  :additional_encryption_context,
  :instance_type,
  :max_concurrent_sessions,
  :portal_custom_domain)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3320

class Portal < Struct.new(
  :portal_arn,
  :renderer_type,
  :browser_type,
  :portal_status,
  :portal_endpoint,
  :display_name,
  :creation_date,
  :browser_settings_arn,
  :data_protection_settings_arn,
  :user_settings_arn,
  :network_settings_arn,
  :session_logger_arn,
  :trust_store_arn,
  :status_reason,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :customer_managed_key,
  :additional_encryption_context,
  :instance_type,
  :max_concurrent_sessions,
  :portal_custom_domain)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3320

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