Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. amplify
  5. getDomain

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

aws-native.amplify.getDomain

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

The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.

Using getDomain

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 getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>
Copy
def get_domain(arn: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(arn: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]
Copy
func LookupDomain(ctx *Context, args *LookupDomainArgs, opts ...InvokeOption) (*LookupDomainResult, error)
func LookupDomainOutput(ctx *Context, args *LookupDomainOutputArgs, opts ...InvokeOption) LookupDomainResultOutput
Copy

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

public static class GetDomain 
{
    public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
public static Output<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:amplify:getDomain
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Arn This property is required. string
ARN for the Domain Association.
Arn This property is required. string
ARN for the Domain Association.
arn This property is required. String
ARN for the Domain Association.
arn This property is required. string
ARN for the Domain Association.
arn This property is required. str
ARN for the Domain Association.
arn This property is required. String
ARN for the Domain Association.

getDomain Result

The following output properties are available:

Arn string
ARN for the Domain Association.
AutoSubDomainCreationPatterns List<string>
Sets the branch patterns for automatic subdomain creation.
AutoSubDomainIamRole string
The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
Certificate Pulumi.AwsNative.Amplify.Outputs.DomainCertificate
CertificateRecord string
DNS Record for certificate verification.
DomainStatus string
Status for the Domain Association.
EnableAutoSubDomain bool
Enables the automated creation of subdomains for branches.
StatusReason string
Reason for the current status of the domain.
SubDomainSettings List<Pulumi.AwsNative.Amplify.Outputs.DomainSubDomainSetting>
The setting for the subdomain.
UpdateStatus string
The status of the domain update operation that is currently in progress. The following list describes the valid update states.

  • REQUESTING_CERTIFICATE - The certificate is in the process of being updated.
  • PENDING_VERIFICATION - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
  • IMPORTING_CUSTOM_CERTIFICATE - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
  • PENDING_DEPLOYMENT - Indicates that the subdomain or certificate changes are being propagated.
  • AWAITING_APP_CNAME - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide .
  • UPDATE_COMPLETE - The certificate has been associated with a domain.
  • UPDATE_FAILED - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.
Arn string
ARN for the Domain Association.
AutoSubDomainCreationPatterns []string
Sets the branch patterns for automatic subdomain creation.
AutoSubDomainIamRole string
The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
Certificate DomainCertificate
CertificateRecord string
DNS Record for certificate verification.
DomainStatus string
Status for the Domain Association.
EnableAutoSubDomain bool
Enables the automated creation of subdomains for branches.
StatusReason string
Reason for the current status of the domain.
SubDomainSettings []DomainSubDomainSetting
The setting for the subdomain.
UpdateStatus string
The status of the domain update operation that is currently in progress. The following list describes the valid update states.

  • REQUESTING_CERTIFICATE - The certificate is in the process of being updated.
  • PENDING_VERIFICATION - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
  • IMPORTING_CUSTOM_CERTIFICATE - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
  • PENDING_DEPLOYMENT - Indicates that the subdomain or certificate changes are being propagated.
  • AWAITING_APP_CNAME - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide .
  • UPDATE_COMPLETE - The certificate has been associated with a domain.
  • UPDATE_FAILED - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.
arn String
ARN for the Domain Association.
autoSubDomainCreationPatterns List<String>
Sets the branch patterns for automatic subdomain creation.
autoSubDomainIamRole String
The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
certificate DomainCertificate
certificateRecord String
DNS Record for certificate verification.
domainStatus String
Status for the Domain Association.
enableAutoSubDomain Boolean
Enables the automated creation of subdomains for branches.
statusReason String
Reason for the current status of the domain.
subDomainSettings List<DomainSubDomainSetting>
The setting for the subdomain.
updateStatus String
The status of the domain update operation that is currently in progress. The following list describes the valid update states.

  • REQUESTING_CERTIFICATE - The certificate is in the process of being updated.
  • PENDING_VERIFICATION - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
  • IMPORTING_CUSTOM_CERTIFICATE - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
  • PENDING_DEPLOYMENT - Indicates that the subdomain or certificate changes are being propagated.
  • AWAITING_APP_CNAME - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide .
  • UPDATE_COMPLETE - The certificate has been associated with a domain.
  • UPDATE_FAILED - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.
arn string
ARN for the Domain Association.
autoSubDomainCreationPatterns string[]
Sets the branch patterns for automatic subdomain creation.
autoSubDomainIamRole string
The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
certificate DomainCertificate
certificateRecord string
DNS Record for certificate verification.
domainStatus string
Status for the Domain Association.
enableAutoSubDomain boolean
Enables the automated creation of subdomains for branches.
statusReason string
Reason for the current status of the domain.
subDomainSettings DomainSubDomainSetting[]
The setting for the subdomain.
updateStatus string
The status of the domain update operation that is currently in progress. The following list describes the valid update states.

  • REQUESTING_CERTIFICATE - The certificate is in the process of being updated.
  • PENDING_VERIFICATION - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
  • IMPORTING_CUSTOM_CERTIFICATE - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
  • PENDING_DEPLOYMENT - Indicates that the subdomain or certificate changes are being propagated.
  • AWAITING_APP_CNAME - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide .
  • UPDATE_COMPLETE - The certificate has been associated with a domain.
  • UPDATE_FAILED - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.
arn str
ARN for the Domain Association.
auto_sub_domain_creation_patterns Sequence[str]
Sets the branch patterns for automatic subdomain creation.
auto_sub_domain_iam_role str
The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
certificate DomainCertificate
certificate_record str
DNS Record for certificate verification.
domain_status str
Status for the Domain Association.
enable_auto_sub_domain bool
Enables the automated creation of subdomains for branches.
status_reason str
Reason for the current status of the domain.
sub_domain_settings Sequence[DomainSubDomainSetting]
The setting for the subdomain.
update_status str
The status of the domain update operation that is currently in progress. The following list describes the valid update states.

  • REQUESTING_CERTIFICATE - The certificate is in the process of being updated.
  • PENDING_VERIFICATION - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
  • IMPORTING_CUSTOM_CERTIFICATE - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
  • PENDING_DEPLOYMENT - Indicates that the subdomain or certificate changes are being propagated.
  • AWAITING_APP_CNAME - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide .
  • UPDATE_COMPLETE - The certificate has been associated with a domain.
  • UPDATE_FAILED - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.
arn String
ARN for the Domain Association.
autoSubDomainCreationPatterns List<String>
Sets the branch patterns for automatic subdomain creation.
autoSubDomainIamRole String
The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
certificate Property Map
certificateRecord String
DNS Record for certificate verification.
domainStatus String
Status for the Domain Association.
enableAutoSubDomain Boolean
Enables the automated creation of subdomains for branches.
statusReason String
Reason for the current status of the domain.
subDomainSettings List<Property Map>
The setting for the subdomain.
updateStatus String
The status of the domain update operation that is currently in progress. The following list describes the valid update states.

  • REQUESTING_CERTIFICATE - The certificate is in the process of being updated.
  • PENDING_VERIFICATION - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
  • IMPORTING_CUSTOM_CERTIFICATE - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
  • PENDING_DEPLOYMENT - Indicates that the subdomain or certificate changes are being propagated.
  • AWAITING_APP_CNAME - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide .
  • UPDATE_COMPLETE - The certificate has been associated with a domain.
  • UPDATE_FAILED - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

Supporting Types

DomainCertificate

CertificateArn string

The Amazon resource name (ARN) for a custom certificate that you have already added to AWS Certificate Manager in your AWS account .

This field is required only when the certificate type is CUSTOM .

CertificateType Pulumi.AwsNative.Amplify.DomainCertificateCertificateType

The type of SSL/TLS certificate that you want to use.

Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

Specify CUSTOM to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into AWS Certificate Manager in the ACM User guide .

CertificateVerificationDnsRecord string
The DNS record for certificate verification.
CertificateArn string

The Amazon resource name (ARN) for a custom certificate that you have already added to AWS Certificate Manager in your AWS account .

This field is required only when the certificate type is CUSTOM .

CertificateType DomainCertificateCertificateType

The type of SSL/TLS certificate that you want to use.

Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

Specify CUSTOM to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into AWS Certificate Manager in the ACM User guide .

CertificateVerificationDnsRecord string
The DNS record for certificate verification.
certificateArn String

The Amazon resource name (ARN) for a custom certificate that you have already added to AWS Certificate Manager in your AWS account .

This field is required only when the certificate type is CUSTOM .

certificateType DomainCertificateCertificateType

The type of SSL/TLS certificate that you want to use.

Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

Specify CUSTOM to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into AWS Certificate Manager in the ACM User guide .

certificateVerificationDnsRecord String
The DNS record for certificate verification.
certificateArn string

The Amazon resource name (ARN) for a custom certificate that you have already added to AWS Certificate Manager in your AWS account .

This field is required only when the certificate type is CUSTOM .

certificateType DomainCertificateCertificateType

The type of SSL/TLS certificate that you want to use.

Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

Specify CUSTOM to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into AWS Certificate Manager in the ACM User guide .

certificateVerificationDnsRecord string
The DNS record for certificate verification.
certificate_arn str

The Amazon resource name (ARN) for a custom certificate that you have already added to AWS Certificate Manager in your AWS account .

This field is required only when the certificate type is CUSTOM .

certificate_type DomainCertificateCertificateType

The type of SSL/TLS certificate that you want to use.

Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

Specify CUSTOM to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into AWS Certificate Manager in the ACM User guide .

certificate_verification_dns_record str
The DNS record for certificate verification.
certificateArn String

The Amazon resource name (ARN) for a custom certificate that you have already added to AWS Certificate Manager in your AWS account .

This field is required only when the certificate type is CUSTOM .

certificateType "AMPLIFY_MANAGED" | "CUSTOM"

The type of SSL/TLS certificate that you want to use.

Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

Specify CUSTOM to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into AWS Certificate Manager in the ACM User guide .

certificateVerificationDnsRecord String
The DNS record for certificate verification.

DomainCertificateCertificateType

DomainSubDomainSetting

BranchName This property is required. string

The branch name setting for the subdomain.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

Prefix This property is required. string
The prefix setting for the subdomain.
BranchName This property is required. string

The branch name setting for the subdomain.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

Prefix This property is required. string
The prefix setting for the subdomain.
branchName This property is required. String

The branch name setting for the subdomain.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

prefix This property is required. String
The prefix setting for the subdomain.
branchName This property is required. string

The branch name setting for the subdomain.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

prefix This property is required. string
The prefix setting for the subdomain.
branch_name This property is required. str

The branch name setting for the subdomain.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

prefix This property is required. str
The prefix setting for the subdomain.
branchName This property is required. String

The branch name setting for the subdomain.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

prefix This property is required. String
The prefix setting for the subdomain.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

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