Class: Aws::WorkSpacesWeb::Types::UpdatePortalRequest

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

Overview

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


2913
2914
2915
2916
2917
2918
2919
2920
2921
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 2913

class UpdatePortalRequest < Struct.new(
  :authentication_type,
  :display_name,
  :instance_type,
  :max_concurrent_sessions,
  :portal_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#display_name ⇒ String

The name of the web portal. This is not visible to users who log into the web portal.

Returns:

  • (String) 


2913
2914
2915
2916
2917
2918
2919
2920
2921
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 2913

class UpdatePortalRequest < Struct.new(
  :authentication_type,
  :display_name,
  :instance_type,
  :max_concurrent_sessions,
  :portal_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#instance_type ⇒ String

The type and resources of the underlying instance.

Returns:

  • (String) 


2913
2914
2915
2916
2917
2918
2919
2920
2921
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 2913

class UpdatePortalRequest < Struct.new(
  :authentication_type,
  :display_name,
  :instance_type,
  :max_concurrent_sessions,
  :portal_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#max_concurrent_sessions ⇒ Integer

The maximum number of concurrent sessions for the portal.

Returns:

  • (Integer) 


2913
2914
2915
2916
2917
2918
2919
2920
2921
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 2913

class UpdatePortalRequest < Struct.new(
  :authentication_type,
  :display_name,
  :instance_type,
  :max_concurrent_sessions,
  :portal_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#portal_arn ⇒ String

The ARN of the web portal.

Returns:

  • (String) 


2913
2914
2915
2916
2917
2918
2919
2920
2921
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 2913

class UpdatePortalRequest < Struct.new(
  :authentication_type,
  :display_name,
  :instance_type,
  :max_concurrent_sessions,
  :portal_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end