Skip to content
AWS for Query.Farm

aws.amplify.get_domain_association

Example SQL Queries

SELECT * FROM
aws.amplify.get_domain_association
WHERE
"app_id" = 'VALUE'
AND "domain_name" = 'VALUE';

Description

Returns the domain information for an Amplify app.

Table Definition

Column NameColumn Data Type
app_id Required Input Column

The unique id for an Amplify app. 

VARCHAR
domain_name Required Input Column

The name of the domain. 

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
domain_association

Describes the structure of a domain association, which associates a custom domain with an Amplify app. 

STRUCT(
    "domain_association_arn" VARCHAR,
    "domain_name" VARCHAR,
    "enable_auto_sub_domain" BOOLEAN,
    "auto_sub_domain_creation_patterns" VARCHAR[],
    "auto_sub_domain_iam_role" VARCHAR,
    "domain_status" VARCHAR,
    "update_status" VARCHAR,
    "status_reason" VARCHAR,
    "certificate_verification_dns_record" VARCHAR,
    "sub_domains" STRUCT(
        "sub_domain_setting" STRUCT(
            "prefix" VARCHAR,
            "branch_name" VARCHAR
        ),
        "verified" BOOLEAN,
        "dns_record" VARCHAR
    )[],
    "certificate" STRUCT(
        "type" VARCHAR,
        "custom_certificate_arn" VARCHAR,
        "certificate_verification_dns_record" VARCHAR
    )
)
Show child fields
domain_association.auto_sub_domain_creation_patterns[]
domain_association.auto_sub_domain_iam_role

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

domain_association.certificate

Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.

If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.

Show child fields
domain_association.certificate.certificate_verification_dns_record

The DNS record for certificate verification.

domain_association.certificate.custom_certificate_arn

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

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

domain_association.certificate.type

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 Certificate Manager in your Amazon Web Services 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 Certificate Manager in the ACM User guide.

domain_association.certificate_verification_dns_record

The DNS record for certificate verification.

domain_association.domain_association_arn

The Amazon Resource Name (ARN) for the domain association.

domain_association.domain_name

The name of the domain.

domain_association.domain_status

The current status of the domain association.

domain_association.enable_auto_sub_domain

Enables the automated creation of subdomains for branches.

domain_association.status_reason

Additional information that describes why the domain association is in the current state.

domain_association.sub_domains[]
Show child fields
domain_association.sub_domains[].dns_record

The DNS record for the subdomain.

domain_association.sub_domains[].sub_domain_setting

Describes the settings for the subdomain.

Show child fields
domain_association.sub_domains[].sub_domain_setting.branch_name

The branch name setting for the subdomain.

domain_association.sub_domains[].sub_domain_setting.prefix

The prefix setting for the subdomain.

domain_association.sub_domains[].verified

The verified status of the subdomain

domain_association.update_status

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.