Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
aws-native.cognito.UserPoolDomain
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource Type definition for AWS::Cognito::UserPoolDomain
Create UserPoolDomain Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new UserPoolDomain(name: string, args: UserPoolDomainArgs, opts?: CustomResourceOptions);@overload
def UserPoolDomain(resource_name: str,
args: UserPoolDomainArgs,
opts: Optional[ResourceOptions] = None)
@overload
def UserPoolDomain(resource_name: str,
opts: Optional[ResourceOptions] = None,
domain: Optional[str] = None,
user_pool_id: Optional[str] = None,
custom_domain_config: Optional[UserPoolDomainCustomDomainConfigTypeArgs] = None)func NewUserPoolDomain(ctx *Context, name string, args UserPoolDomainArgs, opts ...ResourceOption) (*UserPoolDomain, error)public UserPoolDomain(string name, UserPoolDomainArgs args, CustomResourceOptions? opts = null)
public UserPoolDomain(String name, UserPoolDomainArgs args)
public UserPoolDomain(String name, UserPoolDomainArgs args, CustomResourceOptions options)
type: aws-native:cognito:UserPoolDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args UserPoolDomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args UserPoolDomainArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args UserPoolDomainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UserPoolDomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UserPoolDomainArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
UserPoolDomain Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The UserPoolDomain resource accepts the following input properties:
- Domain string
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.
- User
Pool stringId - The user pool ID for the user pool where you want to associate a user pool domain.
- Custom
Domain Pulumi.Config Aws Native. Cognito. Inputs. User Pool Domain Custom Domain Config Type - 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.
- Domain string
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.
- User
Pool stringId - The user pool ID for the user pool where you want to associate a user pool domain.
- Custom
Domain UserConfig Pool Domain Custom Domain Config Type Args - 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.
- domain String
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.
- user
Pool StringId - The user pool ID for the user pool where you want to associate a user pool domain.
- custom
Domain UserConfig Pool Domain Custom Domain Config Type - 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.
- domain string
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.
- user
Pool stringId - The user pool ID for the user pool where you want to associate a user pool domain.
- custom
Domain UserConfig Pool Domain Custom Domain Config Type - 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.
- domain str
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.
- user_
pool_ strid - The user pool ID for the user pool where you want to associate a user pool domain.
- custom_
domain_ Userconfig Pool Domain Custom Domain Config Type Args - 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.
- domain String
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.
- user
Pool StringId - The user pool ID for the user pool where you want to associate a user pool domain.
- custom
Domain Property MapConfig - 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the UserPoolDomain resource produces the following output properties:
- Aws
Id string - The resource ID.
- Cloud
Front stringDistribution - The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
- Id string
- The provider-assigned unique ID for this managed resource.
- Aws
Id string - The resource ID.
- Cloud
Front stringDistribution - The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
- Id string
- The provider-assigned unique ID for this managed resource.
- aws
Id String - The resource ID.
- cloud
Front StringDistribution - The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
- id String
- The provider-assigned unique ID for this managed resource.
- aws
Id string - The resource ID.
- cloud
Front stringDistribution - The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
- id string
- The provider-assigned unique ID for this managed resource.
- aws_
id str - The resource ID.
- cloud_
front_ strdistribution - The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
- id str
- The provider-assigned unique ID for this managed resource.
- aws
Id String - The resource ID.
- cloud
Front StringDistribution - The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
UserPoolDomainCustomDomainConfigType, UserPoolDomainCustomDomainConfigTypeArgs
- Certificate
Arn string - The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
- Certificate
Arn string - The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
- certificate
Arn String - The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
- certificate
Arn string - The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
- certificate_
arn str - The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
- certificate
Arn String - The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.