Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. cognito
  5. getUserPoolDomain

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.cognito.getUserPoolDomain

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Cognito::UserPoolDomain

    Using getUserPoolDomain

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUserPoolDomain(args: GetUserPoolDomainArgs, opts?: InvokeOptions): Promise<GetUserPoolDomainResult>
function getUserPoolDomainOutput(args: GetUserPoolDomainOutputArgs, opts?: InvokeOptions): Output<GetUserPoolDomainResult>
    def get_user_pool_domain(id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetUserPoolDomainResult
def get_user_pool_domain_output(id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetUserPoolDomainResult]
    func LookupUserPoolDomain(ctx *Context, args *LookupUserPoolDomainArgs, opts ...InvokeOption) (*LookupUserPoolDomainResult, error)
func LookupUserPoolDomainOutput(ctx *Context, args *LookupUserPoolDomainOutputArgs, opts ...InvokeOption) LookupUserPoolDomainResultOutput

    > Note: This function is named LookupUserPoolDomain in the Go SDK.

    public static class GetUserPoolDomain 
{
    public static Task<GetUserPoolDomainResult> InvokeAsync(GetUserPoolDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetUserPoolDomainResult> Invoke(GetUserPoolDomainInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUserPoolDomainResult> getUserPoolDomain(GetUserPoolDomainArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:cognito:getUserPoolDomain
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The resource ID.
    Id string
    The resource ID.
    id String
    The resource ID.
    id string
    The resource ID.
    id str
    The resource ID.
    id String
    The resource ID.

    getUserPoolDomain Result

    The following output properties are available:

    CloudFrontDistribution string
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    CustomDomainConfig Pulumi.AwsNative.Cognito.Outputs.UserPoolDomainCustomDomainConfigType
    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.
    Id string
    The resource ID.
    CloudFrontDistribution string
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    CustomDomainConfig UserPoolDomainCustomDomainConfigType
    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.
    Id string
    The resource ID.
    cloudFrontDistribution String
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    customDomainConfig UserPoolDomainCustomDomainConfigType
    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.
    id String
    The resource ID.
    cloudFrontDistribution string
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    customDomainConfig UserPoolDomainCustomDomainConfigType
    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.
    id string
    The resource ID.
    cloud_front_distribution str
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    custom_domain_config UserPoolDomainCustomDomainConfigType
    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.
    id str
    The resource ID.
    cloudFrontDistribution String
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    customDomainConfig Property Map
    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.
    id String
    The resource ID.

    Supporting Types

    UserPoolDomainCustomDomainConfigType

    CertificateArn string
    The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
    CertificateArn string
    The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
    certificateArn String
    The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
    certificateArn 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.
    certificateArn 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 logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi
    pulumi/pulumi-aws-native