@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
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.
|
software.amazon.jsii.JsiiObject.InitializationMode
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
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
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnUserPoolDomain(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnUserPoolDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable) public CfnUserPoolDomain(@NotNull Construct scope, @NotNull String id, @NotNull 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.@Stability(value=Stable) public void inspect(@NotNull TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.@Stability(value=Stable) @NotNull public String getAttrCloudFrontDistribution()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties
in class CfnResource
@Stability(value=Stable) @NotNull public 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.
@Stability(value=Stable) public void setDomain(@NotNull 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.
@Stability(value=Stable) @NotNull public String getUserPoolId()
@Stability(value=Stable) public void setUserPoolId(@NotNull String value)
@Stability(value=Stable) @Nullable public Object getCustomDomainConfig()
Use this object to specify an SSL certificate that is managed by ACM.
@Stability(value=Stable) public void setCustomDomainConfig(@Nullable IResolvable value)
Use this object to specify an SSL certificate that is managed by ACM.
@Stability(value=Stable) public void setCustomDomainConfig(@Nullable CfnUserPoolDomain.CustomDomainConfigTypeProperty value)
Use this object to specify an SSL certificate that is managed by ACM.
Copyright © 2023. All rights reserved.