Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface DomainDescriptionType.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DomainDescriptionType.Builder,DomainDescriptionType>, SdkBuilder<DomainDescriptionType.Builder,DomainDescriptionType>, SdkPojo

Enclosing class:

DomainDescriptionType

public static interface DomainDescriptionType.Builder
extends SdkPojo, CopyableBuilder<DomainDescriptionType.Builder,DomainDescriptionType>

Method Summary

Modifier and Type	Method	Description
DomainDescriptionType.Builder	awsAccountId(String awsAccountId)	The Amazon Web Services account that you created the user pool in.
DomainDescriptionType.Builder	cloudFrontDistribution(String cloudFrontDistribution)	The Amazon CloudFront endpoint that hosts your custom domain.
default DomainDescriptionType.Builder	customDomainConfig(Consumer<CustomDomainConfigType.Builder> customDomainConfig)	The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
DomainDescriptionType.Builder	customDomainConfig(CustomDomainConfigType customDomainConfig)	The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
DomainDescriptionType.Builder	domain(String domain)	The domain string.
DomainDescriptionType.Builder	managedLoginVersion(Integer managedLoginVersion)	The version of managed login branding that you want to apply to your domain.
DomainDescriptionType.Builder	s3Bucket(String s3Bucket)	The Amazon S3 bucket where the static files for this domain are stored.
DomainDescriptionType.Builder	status(String status)	The domain status.
DomainDescriptionType.Builder	status(DomainStatusType status)	The domain status.
DomainDescriptionType.Builder	userPoolId(String userPoolId)	The ID of the user pool that the domain is attached to.
DomainDescriptionType.Builder	version(String version)	The app version.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

userPoolId

DomainDescriptionType.Builder userPoolId(String userPoolId)

The ID of the user pool that the domain is attached to.

Parameters:

userPoolId - The ID of the user pool that the domain is attached to.

Returns:

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

awsAccountId

DomainDescriptionType.Builder awsAccountId(String awsAccountId)

The Amazon Web Services account that you created the user pool in.

Parameters:

awsAccountId - The Amazon Web Services account that you created the user pool in.

Returns:

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

domain

DomainDescriptionType.Builder domain(String domain)

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Parameters:

domain - The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Returns:

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

s3Bucket

DomainDescriptionType.Builder s3Bucket(String s3Bucket)

The Amazon S3 bucket where the static files for this domain are stored.

Parameters:

s3Bucket - The Amazon S3 bucket where the static files for this domain are stored.

Returns:

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

cloudFrontDistribution

DomainDescriptionType.Builder cloudFrontDistribution(String cloudFrontDistribution)

The Amazon CloudFront endpoint that hosts your custom domain.

Parameters:

cloudFrontDistribution - The Amazon CloudFront endpoint that hosts your custom domain.

Returns:

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

version

DomainDescriptionType.Builder version(String version)

The app version.

Parameters:

version - The app version.

Returns:

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

status

DomainDescriptionType.Builder status(String status)

The domain status.

Parameters:

status - The domain status.

Returns:

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

See Also:

DomainStatusType, DomainStatusType

status

DomainDescriptionType.Builder status(DomainStatusType status)

The domain status.

Parameters:

status - The domain status.

Returns:

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

See Also:

DomainStatusType, DomainStatusType

customDomainConfig

DomainDescriptionType.Builder customDomainConfig(CustomDomainConfigType customDomainConfig)

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Parameters:

customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Returns:

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

customDomainConfig

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

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

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:

customDomainConfig(CustomDomainConfigType)

managedLoginVersion

DomainDescriptionType.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) branding and a version of 2 indicates managed login branding.

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

Parameters:

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

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

Returns:

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