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

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

Overview

The summary of the portal.

See Also:

Constant Summary collapse

SENSITIVE = 
[:display_name]

Instance Attribute Summary collapse

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


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  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) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#browser_type ⇒ String

The browser type of the web portal.

Returns:

  • (String) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#creation_date ⇒ Time

The creation date of the web portal.

Returns:

  • (Time) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#data_protection_settings_arn ⇒ String

The ARN of the data protection settings.

Returns:

  • (String) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#display_name ⇒ String

The name of the web portal.

Returns:

  • (String) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#instance_type ⇒ String

The type and resources of the underlying instance.

Returns:

  • (String) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#ip_access_settings_arn ⇒ String

The ARN of the IP access settings.

Returns:

  • (String) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#max_concurrent_sessions ⇒ Integer

The maximum number of concurrent sessions for the portal.

Returns:

  • (Integer) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  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) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#portal_arn ⇒ String

The ARN of the web portal.

Returns:

  • (String) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  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) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#portal_status ⇒ String

The status of the web portal.

Returns:

  • (String) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#renderer_type ⇒ String

The renderer that is used in streaming sessions.

Returns:

  • (String) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  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) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  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) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  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) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  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) 


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 3142

class PortalSummary < 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,
  :user_access_logging_settings_arn,
  :authentication_type,
  :ip_access_settings_arn,
  :instance_type,
  :max_concurrent_sessions)
  SENSITIVE = [:display_name]
  include Aws::Structure
end