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

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.

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

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

Returns:

• (Hash<String,String>)

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

class CreatePortalRequest < Struct.new(
  :additional_encryption_context,
  :authentication_type,
  :client_token,
  :customer_managed_key,
  :display_name,
  :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 AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. 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 765

class CreatePortalRequest < Struct.new(
  :additional_encryption_context,
  :authentication_type,
  :client_token,
  :customer_managed_key,
  :display_name,
  :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 AWS SDK.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

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

class CreatePortalRequest < Struct.new(
  :additional_encryption_context,
  :authentication_type,
  :client_token,
  :customer_managed_key,
  :display_name,
  :tags)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#customer_managed_key ⇒ String

The customer managed key of the web portal.

Returns:

• (String)

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

class CreatePortalRequest < Struct.new(
  :additional_encryption_context,
  :authentication_type,
  :client_token,
  :customer_managed_key,
  :display_name,
  :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.

Returns:

• (String)

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

class CreatePortalRequest < Struct.new(
  :additional_encryption_context,
  :authentication_type,
  :client_token,
  :customer_managed_key,
  :display_name,
  :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.

Returns:

• (Array<Types::Tag>)

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

class CreatePortalRequest < Struct.new(
  :additional_encryption_context,
  :authentication_type,
  :client_token,
  :customer_managed_key,
  :display_name,
  :tags)
  SENSITIVE = [:display_name]
  include Aws::Structure
end