Class CfnUserPoolDomain
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cognito.CfnUserPoolDomain
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
date="2024-05-08T21:35:04.667Z")
@Stability(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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnUserPoolDomain
.static interface
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnUserPoolDomain
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnUserPoolDomain
(software.amazon.jsii.JsiiObjectRef objRef) CfnUserPoolDomain
(software.constructs.Construct scope, String id, CfnUserPoolDomainProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.The resource ID.The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.The domain name for the domain that hosts the sign-up and sign-in pages for your application.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.renderProperties
(Map<String, Object> props) void
setCustomDomainConfig
(IResolvable value) The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.void
The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.void
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.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnUserPoolDomain
protected CfnUserPoolDomain(software.amazon.jsii.JsiiObjectRef objRef) -
CfnUserPoolDomain
protected CfnUserPoolDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnUserPoolDomain
@Stability(Stable) public CfnUserPoolDomain(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserPoolDomainProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
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. -
getAttrId
The resource ID. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getDomain
The domain name for the domain that hosts the sign-up and sign-in pages for your application. -
setDomain
The domain name for the domain that hosts the sign-up and sign-in pages for your application. -
getUserPoolId
The user pool ID for the user pool where you want to associate a user pool domain. -
setUserPoolId
The user pool ID for the user pool where you want to associate a user pool domain. -
getCustomDomainConfig
The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. -
setCustomDomainConfig
The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. -
setCustomDomainConfig
@Stability(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.
-