Interface DomainDescriptionType.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DomainDescriptionType.Builder,
,DomainDescriptionType> SdkBuilder<DomainDescriptionType.Builder,
,DomainDescriptionType> SdkPojo
- Enclosing class:
DomainDescriptionType
-
Method Summary
Modifier and TypeMethodDescriptionawsAccountId
(String awsAccountId) The Amazon Web Services ID for the user pool owner.cloudFrontDistribution
(String cloudFrontDistribution) The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.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.customDomainConfig
(CustomDomainConfigType customDomainConfig) The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.The domain string.The Amazon S3 bucket where the static files for this domain are stored.The domain status.status
(DomainStatusType status) The domain status.userPoolId
(String userPoolId) The user pool ID.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, sdkFields
-
Method Details
-
userPoolId
The user pool ID.
- Parameters:
userPoolId
- The user pool ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
awsAccountId
The Amazon Web Services ID for the user pool owner.
- Parameters:
awsAccountId
- The Amazon Web Services ID for the user pool owner.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 asauth
.- Parameters:
domain
- The domain string. For custom domains, this is the fully-qualified domain name, such asauth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone, such asauth
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
- Parameters:
cloudFrontDistribution
- The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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:
-
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:
-
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 theCustomDomainConfigType.Builder
avoiding the need to create one manually viaCustomDomainConfigType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocustomDomainConfig(CustomDomainConfigType)
.- Parameters:
customDomainConfig
- a consumer that will call methods onCustomDomainConfigType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-