Interface CreateUserPoolDomainRequest.Builder

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

  • Method Details

    • domain

      CreateUserPoolDomainRequest.Builder domain(String domain)

      The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For prefix domains, this is the prefix alone, such as myprefix. A prefix value of myprefix for a user pool in the us-east-1 Region results in a domain of myprefix.auth.us-east-1.amazoncognito.com.

      Parameters:
      domain - The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For prefix domains, this is the prefix alone, such as myprefix. A prefix value of myprefix for a user pool in the us-east-1 Region results in a domain of myprefix.auth.us-east-1.amazoncognito.com.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userPoolId

      CreateUserPoolDomainRequest.Builder userPoolId(String userPoolId)

      The ID of the user pool where you want to add a domain.

      Parameters:
      userPoolId - The ID of the user pool where you want to add a domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • managedLoginVersion

      CreateUserPoolDomainRequest.Builder managedLoginVersion(Integer managedLoginVersion)

      The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) and a version of 2 indicates managed login.

      Managed login requires that your user pool be configured for any feature plan other than Lite.

      A ManagedLoginVersion value of 2 does not activate managed login pages for your app client. When you create an app client programmatically, your app client has no branding style. To use managed login, create a branding style using the CreateManagedLoginBranding operation. When you use the console, Amazon Cognito assigns a default branding style automatically. When you use the API or an SDK, you must create a branding style yourself.

      Parameters:
      managedLoginVersion - The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) and a version of 2 indicates managed login.

      Managed login requires that your user pool be configured for any feature plan other than Lite.

      A ManagedLoginVersion value of 2 does not activate managed login pages for your app client. When you create an app client programmatically, your app client has no branding style. To use managed login, create a branding style using the CreateManagedLoginBranding operation. When you use the console, Amazon Cognito assigns a default branding style automatically. When you use the API or an SDK, you must create a branding style yourself.

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

    • customDomainConfig

      CreateUserPoolDomainRequest.Builder customDomainConfig(CustomDomainConfigType customDomainConfig)

      The configuration for a custom domain. Configures your domain with an Certificate Manager certificate in the us-east-1 Region.

      Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can omit this parameter and use a prefix domain instead.

      When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

      Parameters:
      customDomainConfig - The configuration for a custom domain. Configures your domain with an Certificate Manager certificate in the us-east-1 Region.

      Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can omit this parameter and use a prefix domain instead.

      When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

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

    • customDomainConfig

      default CreateUserPoolDomainRequest.Builder customDomainConfig(Consumer<CustomDomainConfigType.Builder> customDomainConfig)

      The configuration for a custom domain. Configures your domain with an Certificate Manager certificate in the us-east-1 Region.

      Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can omit this parameter and use a prefix domain instead.

      When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customDomainConfig(CustomDomainConfigType).

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

    • routing

      CreateUserPoolDomainRequest.Builder routing(RoutingType routing)

      The configuration of routing for requests to the domain for replicas of a replicated user pool. The routing configuration is currently only supported for custom domains.

      Parameters:
      routing - The configuration of routing for requests to the domain for replicas of a replicated user pool. The routing configuration is currently only supported for custom domains.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routing

      default CreateUserPoolDomainRequest.Builder routing(Consumer<RoutingType.Builder> routing)

      The configuration of routing for requests to the domain for replicas of a replicated user pool. The routing configuration is currently only supported for custom domains.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to routing(RoutingType).

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

    • overrideConfiguration

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

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