Interface CreatePortalRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>, SdkBuilder<CreatePortalRequest.Builder,CreatePortalRequest>, SdkPojo, SdkRequest.Builder, WorkSpacesWebRequest.Builder
Enclosing class:
CreatePortalRequest
@Mutable @NotThreadSafe public static interface CreatePortalRequest.Builder extends WorkSpacesWebRequest.Builder, SdkPojo, CopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>

  • Method Details

    • additionalEncryptionContext

      CreatePortalRequest.Builder additionalEncryptionContext(Map<String,String> additionalEncryptionContext)

      The additional encryption context of the portal.

      Parameters:
      additionalEncryptionContext - The additional encryption context of the portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationType

      CreatePortalRequest.Builder authenticationType(String authenticationType)

      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.

      Parameters:
      authenticationType - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authenticationType

      CreatePortalRequest.Builder authenticationType(AuthenticationType authenticationType)

      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.

      Parameters:
      authenticationType - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreatePortalRequest.Builder clientToken(String clientToken)

      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.

      Parameters:
      clientToken - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerManagedKey

      CreatePortalRequest.Builder customerManagedKey(String customerManagedKey)

      The customer managed key of the web portal.

      Parameters:
      customerManagedKey - The customer managed key of the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      CreatePortalRequest.Builder displayName(String displayName)

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

      Parameters:
      displayName - The name of the web portal. This is not visible to users who log into the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceType

      CreatePortalRequest.Builder instanceType(String instanceType)

      The type and resources of the underlying instance.

      Parameters:
      instanceType - The type and resources of the underlying instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceType

      CreatePortalRequest.Builder instanceType(InstanceType instanceType)

      The type and resources of the underlying instance.

      Parameters:
      instanceType - The type and resources of the underlying instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxConcurrentSessions

      CreatePortalRequest.Builder maxConcurrentSessions(Integer maxConcurrentSessions)

      The maximum number of concurrent sessions for the portal.

      Parameters:
      maxConcurrentSessions - The maximum number of concurrent sessions for the portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePortalRequest.Builder tags(Collection<Tag> tags)

      The tags to add to the web portal. A tag is a key-value pair.

      Parameters:
      tags - The tags to add to the web portal. A tag is a key-value pair.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePortalRequest.Builder tags(Tag... tags)

      The tags to add to the web portal. A tag is a key-value pair.

      Parameters:
      tags - The tags to add to the web portal. A tag is a key-value pair.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePortalRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags to add to the web portal. A tag is a key-value pair.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreatePortalRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreatePortalRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.