@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-25T18:29:07.579Z") public class CfnUserPoolDomain extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnUserPoolDomain(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getCustomDomainConfig()
The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
|
java.lang.String |
getDomain()
The domain name for the domain that hosts the sign-up and sign-in pages for your application.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.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(java.lang.String value)
The domain name for the domain that hosts the sign-up and sign-in pages for your application.
|
void |
setUserPoolId(java.lang.String value)
The user pool ID for the user pool where you want to associate a user pool domain.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnUserPoolDomain(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnUserPoolDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnUserPoolDomain(Construct scope, java.lang.String id, CfnUserPoolDomainProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrCloudFrontDistribution()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getDomain()
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.
public void setDomain(java.lang.String value)
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.
public java.lang.String getUserPoolId()
public void setUserPoolId(java.lang.String value)
public java.lang.Object getCustomDomainConfig()
Use this object to specify an SSL certificate that is managed by ACM.
public void setCustomDomainConfig(IResolvable value)
Use this object to specify an SSL certificate that is managed by ACM.
public void setCustomDomainConfig(CfnUserPoolDomain.CustomDomainConfigTypeProperty value)
Use this object to specify an SSL certificate that is managed by ACM.