aws-native.cognito.getUserPoolDomain

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-aws-native

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(domain: Optional[str] = None,
                         user_pool_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetUserPoolDomainResult
def get_user_pool_domain_output(domain: Optional[pulumi.Input[str]] = None,
                         user_pool_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)
public static Output<GetUserPoolDomainResult> getUserPoolDomain(GetUserPoolDomainArgs args, InvokeOptions options)

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

The following arguments are supported:

Domain string: The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .
UserPoolId string: The ID of the user pool that is associated with the domain you're updating.

Domain string: The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .
UserPoolId string: The ID of the user pool that is associated with the domain you're updating.

domain String: The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .
userPoolId String: The ID of the user pool that is associated with the domain you're updating.

domain string: The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .
userPoolId string: The ID of the user pool that is associated with the domain you're updating.

domain str: The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .
user_pool_id str: The ID of the user pool that is associated with the domain you're updating.

domain String: The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .
userPoolId String: The ID of the user pool that is associated with the domain you're updating.

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