Class: Aws::WorkSpacesWeb::Types::CreatePortalRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::WorkSpacesWeb::Types::CreatePortalRequest
- Defined in:
- gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:display_name]
Instance Attribute Summary collapse
-
#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.
-
#client_token ⇒ String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
-
#customer_managed_key ⇒ String
The customer managed key of the web portal.
-
#display_name ⇒ String
The name of the web portal.
-
#instance_type ⇒ String
The type and resources of the underlying instance.
-
#max_concurrent_sessions ⇒ Integer
The maximum number of concurrent sessions for the portal.
-
#tags ⇒ Array<Types::Tag>
The tags to add to the web portal.
Instance Attribute Details
#additional_encryption_context ⇒ Hash<String,String>
The additional encryption context of the portal.
790 791 792 793 794 795 796 797 798 799 800 801 |
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 790 class CreatePortalRequest < Struct.new( :additional_encryption_context, :authentication_type, :client_token, :customer_managed_key, :display_name, :instance_type, :max_concurrent_sessions, :tags) 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 (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.
790 791 792 793 794 795 796 797 798 799 800 801 |
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 790 class CreatePortalRequest < Struct.new( :additional_encryption_context, :authentication_type, :client_token, :customer_managed_key, :display_name, :instance_type, :max_concurrent_sessions, :tags) SENSITIVE = [:display_name] include Aws::Structure end |
#client_token ⇒ String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
A suitable default value is auto-generated. You should normally not need to pass this option.
790 791 792 793 794 795 796 797 798 799 800 801 |
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 790 class CreatePortalRequest < Struct.new( :additional_encryption_context, :authentication_type, :client_token, :customer_managed_key, :display_name, :instance_type, :max_concurrent_sessions, :tags) SENSITIVE = [:display_name] include Aws::Structure end |
#customer_managed_key ⇒ String
The customer managed key of the web portal.
790 791 792 793 794 795 796 797 798 799 800 801 |
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 790 class CreatePortalRequest < Struct.new( :additional_encryption_context, :authentication_type, :client_token, :customer_managed_key, :display_name, :instance_type, :max_concurrent_sessions, :tags) 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.
790 791 792 793 794 795 796 797 798 799 800 801 |
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 790 class CreatePortalRequest < Struct.new( :additional_encryption_context, :authentication_type, :client_token, :customer_managed_key, :display_name, :instance_type, :max_concurrent_sessions, :tags) SENSITIVE = [:display_name] include Aws::Structure end |
#instance_type ⇒ String
The type and resources of the underlying instance.
790 791 792 793 794 795 796 797 798 799 800 801 |
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 790 class CreatePortalRequest < Struct.new( :additional_encryption_context, :authentication_type, :client_token, :customer_managed_key, :display_name, :instance_type, :max_concurrent_sessions, :tags) SENSITIVE = [:display_name] include Aws::Structure end |
#max_concurrent_sessions ⇒ Integer
The maximum number of concurrent sessions for the portal.
790 791 792 793 794 795 796 797 798 799 800 801 |
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 790 class CreatePortalRequest < Struct.new( :additional_encryption_context, :authentication_type, :client_token, :customer_managed_key, :display_name, :instance_type, :max_concurrent_sessions, :tags) SENSITIVE = [:display_name] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
The tags to add to the web portal. A tag is a key-value pair.
790 791 792 793 794 795 796 797 798 799 800 801 |
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 790 class CreatePortalRequest < Struct.new( :additional_encryption_context, :authentication_type, :client_token, :customer_managed_key, :display_name, :instance_type, :max_concurrent_sessions, :tags) SENSITIVE = [:display_name] include Aws::Structure end |