aws-native.cognito.UserPoolDomain

Explore with Pulumi AI

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

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

pulumi/pulumi-aws-native

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.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const userPoolDomainResource = new aws_native.cognito.UserPoolDomain("userPoolDomainResource", {
    domain: "string",
    userPoolId: "string",
    customDomainConfig: {
        certificateArn: "string",
    },
});

Coming soon!

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
UserPoolId string
CustomDomainConfig Pulumi.AwsNative.Cognito.Inputs.UserPoolDomainCustomDomainConfigType

Domain string
UserPoolId string
CustomDomainConfig UserPoolDomainCustomDomainConfigTypeArgs

domain String
userPoolId String
customDomainConfig UserPoolDomainCustomDomainConfigType

domain string
userPoolId string
customDomainConfig UserPoolDomainCustomDomainConfigType

domain str
user_pool_id str
custom_domain_config UserPoolDomainCustomDomainConfigTypeArgs

domain String
userPoolId String
customDomainConfig Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the UserPoolDomain resource produces the following output properties: