software.amazon.awscdk.services.cognito

Class CfnUserPoolDomain

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cognito.CfnUserPoolDomain

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:09:30.545Z")
 @Stability(value=Stable)
public class CfnUserPoolDomain
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cognito::UserPoolDomain`.

The AWS::Cognito::UserPoolDomain resource creates a new domain for a user pool.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnUserPoolDomain cfnUserPoolDomain = CfnUserPoolDomain.Builder.create(this, "MyCfnUserPoolDomain")
         .domain("domain")
         .userPoolId("userPoolId")
         // the properties below are optional
         .customDomainConfig(CustomDomainConfigTypeProperty.builder()
                 .certificateArn("certificateArn")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnUserPoolDomain.Builder A fluent builder for CfnUserPoolDomain.
static interface	CfnUserPoolDomain.CustomDomainConfigTypeProperty The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUserPoolDomain(Construct scope, String id, CfnUserPoolDomainProps props) Create a new `AWS::Cognito::UserPoolDomain`.
protected	CfnUserPoolDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolDomain(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCloudFrontDistribution() The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
protected Map<String,Object>	getCfnProperties()
Object	getCustomDomainConfig() The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
String	getDomain() The domain name for the domain that hosts the sign-up and sign-in pages for your application.
String	getUserPoolId() The user pool ID for the user pool where you want to associate a user pool domain.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCustomDomainConfig(CfnUserPoolDomain.CustomDomainConfigTypeProperty value) The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
void	setCustomDomainConfig(IResolvable value) The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
void	setDomain(String value) The domain name for the domain that hosts the sign-up and sign-in pages for your application.
void	setUserPoolId(String value) The user pool ID for the user pool where you want to associate a user pool domain.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUserPoolDomain

protected CfnUserPoolDomain(software.amazon.jsii.JsiiObjectRef objRef)

CfnUserPoolDomain

protected CfnUserPoolDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUserPoolDomain

@Stability(value=Stable)
public CfnUserPoolDomain(@NotNull
                                                  Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnUserPoolDomainProps props)

Create a new `AWS::Cognito::UserPoolDomain`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCloudFrontDistribution

@Stability(value=Stable)
 @NotNull
public String getAttrCloudFrontDistribution()

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDomain

@Stability(value=Stable)
 @NotNull
public String getDomain()

The domain name for the domain that hosts the sign-up and sign-in pages for your application.

For example: auth.example.com . If you're using a prefix domain, this field denotes the first part of the domain before .auth.[region].amazoncognito.com .

This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.

setDomain

@Stability(value=Stable)
public void setDomain(@NotNull
                                               String value)

The domain name for the domain that hosts the sign-up and sign-in pages for your application.

For example: auth.example.com . If you're using a prefix domain, this field denotes the first part of the domain before .auth.[region].amazoncognito.com .

This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.

getUserPoolId

@Stability(value=Stable)
 @NotNull
public String getUserPoolId()

The user pool ID for the user pool where you want to associate a user pool domain.

setUserPoolId

@Stability(value=Stable)
public void setUserPoolId(@NotNull
                                                   String value)

The user pool ID for the user pool where you want to associate a user pool domain.

getCustomDomainConfig

@Stability(value=Stable)
 @Nullable
public Object getCustomDomainConfig()

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

Use this object to specify an SSL certificate that is managed by ACM.

setCustomDomainConfig

@Stability(value=Stable)
public void setCustomDomainConfig(@Nullable
                                                           IResolvable value)

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

Use this object to specify an SSL certificate that is managed by ACM.

setCustomDomainConfig

@Stability(value=Stable)
public void setCustomDomainConfig(@Nullable
                                                           CfnUserPoolDomain.CustomDomainConfigTypeProperty value)

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

Use this object to specify an SSL certificate that is managed by ACM.