AppRunner / Client / disassociate_custom_domain

disassociate_custom_domain

AppRunner.Client.disassociate_custom_domain(**kwargs)

Disassociate a custom domain name from an App Runner service.

Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM). These certificates aren’t deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_custom_domain(
    ServiceArn='string',
    DomainName='string'
)

Parameters:

• ServiceArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.

• DomainName (string) –

  [REQUIRED]

  The domain name that you want to disassociate from the App Runner service.

Return type:

dict

Returns:

Response Syntax

{
    'DNSTarget': 'string',
    'ServiceArn': 'string',
    'CustomDomain': {
        'DomainName': 'string',
        'EnableWWWSubdomain': True|False,
        'CertificateValidationRecords': [
            {
                'Name': 'string',
                'Type': 'string',
                'Value': 'string',
                'Status': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED'
            },
        ],
        'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETE_FAILED'|'PENDING_CERTIFICATE_DNS_VALIDATION'|'BINDING_CERTIFICATE'
    },
    'VpcDNSTargets': [
        {
            'VpcIngressConnectionArn': 'string',
            'VpcId': 'string',
            'DomainName': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • DNSTarget (string) –

    The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this target name.

  • ServiceArn (string) –

    The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from.

  • CustomDomain (dict) –

    A description of the domain name that’s being disassociated.

    • DomainName (string) –

      An associated custom domain endpoint. It can be a root domain (for example, example.com), a subdomain (for example, login.example.com or admin.login.example.com), or a wildcard (for example, *.example.com).

    • EnableWWWSubdomain (boolean) –

      When true, the subdomain ``www.DomainName ``is associated with the App Runner service in addition to the base domain.

    • CertificateValidationRecords (list) –

      A list of certificate CNAME records that’s used for this domain name.

      • (dict) –

        Describes a certificate CNAME record to add to your DNS. For more information, see AssociateCustomDomain.

        • Name (string) –

          The certificate CNAME record name.

        • Type (string) –

          The record type, always CNAME.

        • Value (string) –

          The certificate CNAME record value.

        • Status (string) –

          The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your DNS.

    • Status (string) –

      The current state of the domain name association.

  • VpcDNSTargets (list) –

    DNS Target records for the custom domains of this Amazon VPC.

    • (dict) –

      DNS Target record for a custom domain of this Amazon VPC.

      • VpcIngressConnectionArn (string) –

        The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.

      • VpcId (string) –

        The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.

      • DomainName (string) –

        The domain name of your target DNS that is associated with the Amazon VPC.

Exceptions

• AppRunner.Client.exceptions.InvalidRequestException

• AppRunner.Client.exceptions.InternalServiceErrorException

• AppRunner.Client.exceptions.ResourceNotFoundException

• AppRunner.Client.exceptions.InvalidStateException